Exchange API services and descriptions
Name Description

Login

The API Login service enables customers to log in to the Exchange API service and initiates a secure session for the user. Users can have multiple sessions alive at any point in time.

Logout The API Logout service allows you to explicitly end your session.

KeepAlive

The keep alive service can be used to stop a session timing out. Normally a session is expired if it has been idle for a period of time. Issuing periodic KeepAlive requests will stop this occurring.

GetActiveEventTypes

The Exchange API Get Active Event Types service allows the customer to retrieve all Sports (Games, Event Types) which have at least one active/suspended market associated with it currently. This service would for example always return the event types Soccer and Horse Racing but would not include Olympics 2012.

GetAllEventTypes

The Exchange API Get All Event Types service allows the customer to retrieve all Sports (Games, Event Types) regardless of whether they have an active market associated with them. This service would for example always return the event types Soccer and Horse Racing and would also include Swimming, Olympics 2004 or EURO 2004 even when the events have finished or have no current events. This is to allow API programmers to be aware of the full range of potential sports that may be available in future.

GetEvents

GetEvents is used to navigate through the menu structure. It allows you to input a Sport or Event and retrieve all Events or Markets which have the input event id as a parent.

GetMarket

The API Get Market service allows the customer to input a Market ID and retrieve all static market data for the market.

GetAllMarkets The API GetAllMarkets service allows you to retrieve information about all of the markets that are currently active or suspended on the given exchange. You can use this service to quickly analyse the available markets on the exchange, or use the response to build a local copy of the Betfair.com navigation menu. You can limit the response to a particular time period, country where the event is taking place, and event type. Otherwise, the service returns all active and suspended markets.

GetMarketPrices

The API Get Market Prices service is used to retrieve dynamic market data for a given Market ID.

GetMarketPricesCompressed

The Exchange API Get Market Prices Compressed service is used to retrieve dynamic market data for a given Market ID. This service returns the same information as the Get Market Prices service but returns it in a ~ (tilde) delimited String.

GetBetHistory

The Get Bet History service is used to retrieve information about bets that have been placed. Each request can only retrieve bets of the same status (MATCHED/UNMATCHED etc.) Pagination through the result set is supported using the startRecord and maxRecords parameters.

GetAccountFunds

The Exchange API Get Account Funds service allows the customer to retrieve financial information about their account.

GetDetailAvailableMktDepth

The Get Detail Available Market Depth service returns the current odds and available bet/lay amounts on a runner in an event.

GetSubscriptionInfo

The Get Subscription Info service returns information on your API subscription.

GetSilks

The Get Silks service returns a URL to a jockey silk image and additional data about the selection, such as the silk description, trainer name, etc...

GetAccountStatement

The Account Statement service allows the user to obtain information on transactions that have occurred on an account.

GetCurrentBets

Retrieve information about bets that have been placed. Information can either be retrieved from either a single market or across all markets. This requests supports paging through the result set through the use of the Starting Record and Record Count parameters.

GetBet

The Get Bet service is used to retrieve information a specific bet that has been placed. Each request will retrieve all components of the desired bet.

GetMUBets

The GetMUBets service allows you to retrieve information about all your matched and unmatched bets on a particular exchange server.

GetMarketProfitAndLoss

Retrieve Profit and Loss information for the user account in a given market.

The limitations for the service in the initial release are:

- Profit and loss for single and multi-winner odds markets is implemented however it won�t calculate worstCaseIfWin nor futureIfWin.

- The calculation for AH markets will include worstCaseIfWin but not futureIfWin.

GetMarketTradedVolume

The Get Market Traded Volume service is used to obtain all the current odds and matched amounts on the runners in an event.

GetAllCurrencies

The Exchange API Get All Currencies service allows the customer to retrieve all the available currencies and their exchange rates.

WithdrawToPaymentCard The API WithdrawToPaymentCard service allows you to withdraw funds from your UK wallet using a previously registered payment card.
DepositFromPaymentCard The API DepositFromPaymentCard service allows you to deposit funds into your UK wallet from a previously registered payment card. You cannot deposit funds directly into your Australian wallet.
TransferFunds The TransferFunds service is for transferring funds between your UK and Australian account wallets.

ConvertCurrency

The Exchange API Convert Currency service allows the customer to convert a currency

Transactional Services
Name Description

PlaceBets

The Exchange API Place Bets service allows multiple bets to be placed on a single Market. There is an instance of PlaceBetsResp returned in the output for each instance of PlaceBets in the input.

UpdateBets

The Exchange API Update Bets service allows editing of multiple bets on a single Market. There is an instance of UpdateBetsResp returned in the output for each instance of UpdateBets in the input.

CancelBets

The Exchange API Cancel Bets service allows you to cancel multiple bets on a single Market. There is an instance of CancelBetsResp returned in the output for each instance of CancelBets in the input.

CancelBetsByMarket

The Exchange API CancelBetsByMarket service allows you to cancel all unmatched bets(or unmatched portions of bets) placed on one or more Markets. You might use this service to quickly close out a position on a market.

There are also several further Exchange API services available, including those specifically for the use of prospective Betfair commercial partners. Please inquire as to the specifics.
back to top