![](/user_photo/2706_HbeT2.jpg)
- •Getting Started with API-NG
- •Application Keys
- •API-NG Login
- •Non-Interactive (bot) login
- •Certificate Generation With XCA
- •Interactive Login from a Desktop Application
- •Interactive Login - API Endpoint
- •Login FAQs
- •Keep Alive
- •Logout
- •API-NG - Visualiser
- •Example Requests
- •Market Data Request Limits
- •Understanding Market Navigation
- •API 6.0 > API-NG Operations Comparison Table
- •API-NG Reference Guide
- •Betting API
- •Betfair Starting Price Betting (BSP)
- •Betting on Australian Events
- •Betting On Italian Exchange
- •Navigation Data For Applications
- •Betting Operations
- •listCompetitions
- •listCountries
- •listCurrentOrders
- •listClearedOrders
- •listClearedOrders - Roll-up Fields Available
- •listEvents
- •listEventTypes
- •listMarketBook
- •listMarketCatalogue
- •listMarketProfitAndLoss
- •listMarketTypes
- •listTimeRanges
- •listVenues
- •placeOrders
- •Italian Exchange Specific Bet Rules
- •cancelOrders
- •replaceOrders
- •updateOrders
- •Betting Exceptions
- •Betting Enums
- •Betting Type Definitions
- •Accounts API
- •Accounts Operations
- •createDeveloperAppKeys
- •getAccountDetails
- •getAccountFunds
- •getDeveloperAppKeys
- •getAccountStatement
- •listCurrencyRates
- •transferFunds
- •Account Operations (Vendor API)
- •activateApplicationSubscription
- •cancelApplicationSubscription
- •getApplicationSubscriptionHistory
- •getApplicationSubscriptionToken
- •getVendorClientId
- •listAccountSubscriptionTokens
- •listApplicationSubscriptionTokens
- •updateApplicationSubscription
- •Accounts Exceptions
- •Accounts Enums
- •Accounts TypeDefinitions
- •Heartbeat API
- •Vendor Services in API-NG
- •Interface Definition Documents
- •Additional Information
- •Betfair Price Increments
- •Currency Parameters
- •Racecourse Abbreviations
- •Runner Metadata Description
- •Time Zones
- •Common Error Codes
- •Sample Code
- •Excel & VBA Sample
- •Java
- •Javascript
- •Python
![](/html/2706/431/html_jyB9jjgVRS.jaxZ/htmlconvd-IOyKnG191x1.jpg)
You can make requests for your UK Exchange wallet information by accessing the UK Exchange via the following endpoints.
UK Exchange |
|
|
|
Interface |
Endpoint |
JSON-RPC Prefix |
<methodname> |
|
|
|
Example |
JSON-RPC |
https://api.betfair.com/exc <methodname> |
AccountAPING/v1.0/ge |
|
|
hange/account/json-rpc/v1 |
|
tAccountFunds |
JSON REST |
https://api.betfair.com/exc |
|
|
|
hange/account/rest/v1.0 |
|
|
You can make requests for your Aus Exchange wallet information by accessing the Aus Exchange via the following endpoints.
Australian Exchange |
|
|
|
Interface |
Endpoint |
JSON-RPC Prefix |
<methodname> |
|
|
|
Example |
JSON-RPC |
https://api-au.betfair.com/ <methodname> |
AccountAPING/v1.0/getA |
|
|
exchange/account/json-rp |
|
ccountFunds |
|
c/v1 |
|
|
JSON REST |
https://api-au.betfair.com/ |
|
|
|
exchange/account/rest/v1. |
|
|
|
0 |
|
|
*Please note the getAccountFunds operations for the Australian Exchange doesn’t currently return details from the Australian wallet. This is due to be rectified in a future release.
Accounts Operations
Operation summary |
|
DeveloperApp |
createDeveloperAppKeys (String |
|
appName ) |
List< DeveloperApp > |
getDeveloperAppKeys ( ) |
AccountFundsResponse |
getAccountFunds ( ) |
TransferResponse |
transferFunds ( Wallet from, Wallet t |
|
o, double amount ) |
AccountDetailsResponse |
getAccountDetails ( ) |
String |
getVendorClientId ( ) |
![](/html/2706/431/html_jyB9jjgVRS.jaxZ/htmlconvd-IOyKnG192x1.jpg)
String |
getApplicationSubscriptionToken ( |
Available to owner managed |
|
intsubscriptionLength ) |
(Vendor) App Keys Only |
Status |
activateApplicationSubscription ( |
|
|
StringsubscriptionToken ) |
|
Status |
cancelApplicationSubscription ( |
Available to owner managed |
|
StringsubscriptionToken ) |
(Vendor) App Keys Only |
String |
updateApplicationSubscription ( Stri |
Available to owner managed |
|
ng vendorClientId, int |
(Vendor) App Keys Only |
|
subscriptionLength ) |
|
List< ApplicationSubscription > |
listApplicationSubscriptionTokens ( |
|
|
SubscriptionStatus subscriptionStat |
|
|
us ) |
|
List< AccountSubscription > |
listAccountSubscriptionTokens ( ) |
Available to owner managed |
|
|
(Vendor) App Keys Only |
List<SubscriptionHistory> |
getApplicationSubscriptionHistory ( |
Available to owner managed |
|
String vendorClientId ) |
(Vendor) App Keys Only |
AccountStatementReport |
getAccountStatement ( String |
|
|
locale, int fromRecord, int |
|
|
recordCount, TimeRange itemDate |
|
|
Range, IncludeItem includeItem,Wa |
|
|
lletwallet ) |
|
List<CurrencyRate> |
listCurrencyRates ( String |
|
|
fromCurrency ) |
|
createDeveloperAppKeys
Operation
![](/html/2706/431/html_jyB9jjgVRS.jaxZ/htmlconvd-IOyKnG193x1.jpg)
createDeveloperAppKeys
DeveloperApp createDeveloperAppKeys ( String appName ) throws AccountAPINGException
Create 2 application keys for given user; one active and the other delayed
Parameter name |
Type |
Required |
Description |
appName |
String |
|
A Display name for the |
|
|
|
application. |
Return type |
|
Description |
|
DeveloperApp |
|
A map of application keys, one marked ACTIVE, |
|
|
|
and the other DELAYED |
|
Throws |
|
Description |
|
AccountAPINGException |
|
Generic exception that is thrown if this operation |
|
|
|
fails for any reason. |
|
Since 1.0.0
getAccountDetails
Operation
getAccountDetails
AccountDetailsResponse getAccountDetails ( ) throws AccountAPINGException
Returns the details relating your account, including your discount rate and Betfair point balance.
Return type |
Description |
AccountDetailsResponse |
Response for retrieving account details. |
Throws |
Description |
AccountAPINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0
![](/html/2706/431/html_jyB9jjgVRS.jaxZ/htmlconvd-IOyKnG194x1.jpg)
Please note: The data returned by getAccountDetails relies on two underlying services. The p ointsBalance is returned by a separate service from the other data.
As a consequence of this, in the event of a failure to a single underlying service, either the point sBalance or the remaining data may not be included in the getAccountDetails response. If both services fail, the error UNEXPECTED_ERROR will be returned.
getAccountFunds
Operation
getAccountFunds
AccountFundsResponse getAccountFunds ( ) throws AccountAPINGException
Get available to bet amount. The getAccounts service will return the UK wallet balance by default from either the UK or AUS Accounts API endpoint if the wallet parameter is not specified.
Parameter name |
Type |
Required |
Description |
wallet |
Wallet |
|
Name of the wallet in |
|
|
|
question. Please Note: |
|
|
|
To return the the |
|
|
|
Australian Exchange |
|
|
|
wallet balance you |
|
|
|
must specify AUSTRA |
|
|
|
LIAN as the Wallet |
|
|
|
parameter. |
Return type |
|
Description |
|
AccountFundsResponse |
|
Response for retrieving available to bet. |
|
Throws |
|
Description |
|
AccountAPINGException |
|
Generic exception that is thrown if this operation |
|
|
|
fails for any reason. |
|
Since 1.0.0
getDeveloperAppKeys
Operation