
- •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

Event Id |
Y |
Y |
Y |
Y |
N |
N |
Market Id |
Y |
Y |
Y |
N |
N |
N |
Selection Id |
Y |
Y |
N |
N |
N |
N |
Handicap |
Y |
Y |
N |
N |
N |
N |
Side |
Y |
Y |
N |
N |
N |
N |
Price |
Y |
AVG |
N(AVG) |
N |
N |
N |
Requested |
|
|
|
|
|
|
Price |
Y |
AVG |
N(AVG) |
N |
N |
N |
Matched |
|
|
|
|
|
|
Size Settled |
Y |
SUM |
N(SUM) |
N |
N |
N |
Price |
Y |
Y |
Y |
N |
N |
N |
Reduced |
|
|
|
|
|
|
Commission |
N |
N |
Y |
SUM |
SUM |
SUM |
Bet Id |
Y |
N |
N |
N |
N |
N |
Placed Date |
Y |
MAX |
MAX |
N |
N |
N |
Persistence |
Y |
Y |
Y |
N |
N |
N |
Type |
|
|
|
|
|
|
Order Type |
Y |
Y |
Y |
N |
N |
N |
Regulator |
Y |
Y |
Y |
N |
N |
N |
Code |
|
|
|
|
|
|
Regulator |
Y |
Y |
Y |
N |
N |
N |
Auth Code |
|
|
|
|
|
|
Voided Date( |
Y |
MAX |
MAX |
N |
N |
N |
where |
|
|
|
|
|
|
applicable) |
|
|
|
|
|
|
listEvents
Operation

listEvents
List< EventResult > listEvents ( MarketFilter filter ,Stringlocale ) throws APINGException
Returns a list of Events (i.e, Reading vs. Man United) associated with the markets selected by the MarketFilter.
Parameter name |
Type |
Required |
Description |
filter |
MarketFilter |
|
The filter to select |
|
|
|
desired markets. All |
|
|
|
markets that match the |
|
|
|
criteria in the filter are |
|
|
|
selected. |
locale |
String |
|
The language used for |
|
|
|
the response. If not |
|
|
|
specified, the default is |
|
|
|
returned. |
Return type |
Description |
List< EventResult > |
output data |
Throws |
Description |
APINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listEventTypes
Operation

listEventTypes
List< EventTypeResult > listEventTypes ( MarketFilter filter ,Stringlocale ) throws APINGExceptio n
Returns a list of Event Types (i.e. Sports) associated with the markets selected by the MarketFilter.
Parameter name |
Type |
Required |
Description |
filter |
MarketFilter |
|
The filter to select |
|
|
|
desired markets. All |
|
|
|
markets that match the |
|
|
|
criteria in the filter are |
|
|
|
selected. |
locale |
String |
|
The language used for |
|
|
|
the response. If not |
|
|
|
specified, the default is |
|
|
|
returned. |
Return type |
Description |
List< EventTypeResult > |
output data |
Throws |
Description |
APINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listMarketBook
Operation
listMarketBook
List< MarketBook > listMarketBook ( List<String>marketIds , PriceProjection priceProjection, Ord erProjection orderProjection, MatchProjection matchProjection,StringcurrencyCode,Stringlocale ) throws APINGException
Returns a list of dynamic data about markets. Dynamic data includes prices, the status of the market, the status of selections, the traded volume, and the status of any orders you have placed in the market.

Please note: Market Data Request Limits apply to requests made to listMarketBook that include price or order projections.
Calls to listMarketBook should be made up to a maximum of 5 times per second to a single marketId.
Parameter name |
Type |
Required |
Description |
marketIds |
List<String> |
|
One or more market |
|
|
|
ids. The number of |
|
|
|
markets returned |
|
|
|
depends on the amount |
|
|
|
of data you request via |
|
|
|
the price projection. |
priceProjection |
PriceProjection |
|
The projection of price |
|
|
|
data you want to |
|
|
|
receive in the |
|
|
|
response. |
orderProjection |
OrderProjection |
|
The orders you want to |
|
|
|
receive in the |
|
|
|
response. |
matchProjection |
MatchProjection |
|
If you ask for orders, |
|
|
|
specifies the |
|
|
|
representation of |
|
|
|
matches. |
currencyCode |
String |
|
A Betfair standard |
|
|
|
currency code. If not |
|
|
|
specified, the default |
|
|
|
currency code is used. |
locale |
String |
|
The language used for |
|
|
|
the response. If not |
|
|
|
specified, the default is |
|
|
|
returned. |
Return type |
Description |
List< MarketBook > |
output data |
Throws |
Description |
APINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |