Skip to main content

A betfair parser

Project description

betfair_parser logo

GitHub Build Status PyPI Python Version License Code style: black

betfair_parser

A simple and fast betfair parser. Why you might like this library:

  • Complete: All betfair (non-vendor) client API included
  • Conventions: The API strictly follows pythonic naming conventions
  • Consistency: All data is type checked, API requests as well as responses
  • Comfort: All betfair enums and type definitions are included, to support IDE syntax completion
  • Clear errors: API errors don't just throw cryptic codes, but contain documentation about that error
  • Compatible: Use it with any HTTP library you like, including async libraries
  • Cheetah fast: Thanks to the magic of msgspec, megabytes of input parse in milliseconds

Usage

betfair_parser is built out of API building blocks, that can be used with any HTTP client you like. All API operations provide .headers(), .body() and a .parse_response() method.

The client module contains a sample, minimalistic client implementation. It may be used as is with any requests-compatible HTTP client or serve as an example, how to integrate betfair_parser with other HTTP clients.

import requests
from betfair_parser import client
from betfair_parser.spec import accounts, betting

session = requests.Session()  # or anything similar like httpx.Client()
client.login(session, "username", "password", "app_key")
client.request(session, accounts.GetAccountFunds.with_params())
# AccountFundsResponse(available_to_bet_balance=10000.0, exposure=0.0,
# retained_commission=0.0, exposure_limit=-10000.0, discount_rate=0.0,
# points_balance=10, wallet=<Wallet.UK: 'UK'>)

# Request with an invalid wallet parameter:
client.request(session, accounts.GetAccountFunds.with_params(wallet="AUS"))
# >>> AccountAPINGException: INVALID_PARAMETERS: Problem parsing the parameters,
#     or a mandatory parameter was not found

client.request(session, betting.ListCurrentOrders.with_params())
# CurrentOrderSummaryReport(current_orders=[], more_available=False)

# Support for other countries
from betfair_parser.endpoints import endpoint
endpoint_cfg = endpoint("ITA")  # alpha-3 code
client.login(session, "username", "password", "app_key", endpoints=endpoint_cfg)

See test_live.py for more API call examples.

Releasing

Releases are published automatically when a tag is pushed to GitHub.

# Set next version number
export RELEASE=x.x.x

# Create tags
git commit --allow-empty -m "Release $RELEASE"
git tag -a $RELEASE -m "Version $RELEASE"

# Push
git push --tags
git push

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

betfair_parser-0.12.0.tar.gz (54.9 kB view hashes)

Uploaded Source

Built Distribution

betfair_parser-0.12.0-py3-none-any.whl (65.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page