Versions Compared

Old Version 100

changes.mady.by.user PepikM

Saved on

compared with

New Version Current

changes.mady.by.user Neil Thomas

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

Appanvil karma designer
summary Home | API Status | Historical Data | Vendor Program | Developer Forum Application Keys
page{"id":"EJyr1dNQxAJdJguiodbJA","name":"page","children":[{"id":"iOCUkGtPzoYzSRQ_IZAXO","params":{"background":{"light":"#ffffff99","dark":"#1d212599"},"padding":20,"gap":10,"backgroundSize":"contain","image":{"value":"att19398657","target":"_blank","type":"attachment"}},"children":[],"name":"section"},{"params":{"padding":0,"gap":0,"image":{"value":"https://images.unsplash.com/photo-1554034483-04fda0d3507b?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3wzMzg3MzF8MHwxfHNlYXJjaHw2fHxncmFkaWVudHxlbnwwfDB8fHwxNzAyMzkyMDI1fDA&ixlib=rb-4.0.3&q=80&w=1080","target":"_self","type":"link"},"background":{"type":"solid","dark":"#1D2125","light":"#000000"}},"children":[{"name":"row","children":[{"name":"column","children":[{"name":"text","params":{"templateId":"headline 2","value":[{"type":"paragraph","children":[{"type":"paragraph","children":[{"text":"","fontSize":18},{"type":"link","link":{"value":"https://betfair-developer-docs.atlassian.net/wiki/spaces/1smk3cen4v3lu3yomq5qye0ni/overview","target":"_blank","type":"link"},"children":[{"text":"Home","letterSpacing":0,"fontFamily":"Poppins, sans-serif","backgroundColor":{"type":"solid","light":"#000000"},"color":{"type":"solid","light":"#ffffff"},"fontSize":18}]},{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","text":" | ","backgroundColor":{"type":"solid","light":"#000000"},"color":{"type":"solid","light":"#ffffff"},"fontSize":18},{"type":"link","link":{"value":"https://status.developer.betfair.com/","target":"_blank","type":"link"},"children":[{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","text":"API Status ","backgroundColor":{"type":"solid","light":"#000000"},"color":{"type":"solid","light":"#ffffff"},"fontSize":18}]},{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","text":"| ","backgroundColor":{"type":"solid","light":"#000000"},"color":{"type":"solid","light":"#ffffff"},"fontSize":18},{"type":"link","link":{"value":"https://historicdata.betfair.com/","target":"_blank","type":"link"},"children":[{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","backgroundColor":{"type":"solid","light":"#000000"},"text":"Historical Data","color":{"type":"solid","light":"#ffffff"},"fontSize":18}]},{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","backgroundColor":{"type":"solid","light":"#000000"},"text":" | ","color":{"type":"solid","light":"#ffffff"},"fontSize":18},{"type":"link","link":{"value":"https://developer.betfair.com/en/vendor-program/the-process/","target":"_blank","type":"link"},"children":[{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","backgroundColor":{"type":"solid","light":"#000000"},"text":"Vendor Program","color":{"type":"solid","light":"#ffffff"},"fontSize":18}]},{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","backgroundColor":{"type":"solid","light":"#000000"},"text":" | ","color":{"type":"solid","light":"#ffffff"},"fontSize":18},{"type":"link","link":{"value":"https://forum.developer.betfair.com/","target":"_blank","type":"link"},"children":[{"letterSpacing":0,"fontFamily":"Poppins, sans-serif","text":"Developer Forum","backgroundColor":{"type":"solid","light":"#000000"},"color":{"type":"solid","light":"#ffffff"},"fontSize":18}]},{"text":""}],"align":"center"}]}]},"children":[],"id":"CO2FLq4NeFdddoCtq1lBg"}],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":20,"verticalAlignment":"top"},"id":"rJ16aA1aMkr8JRkTqLleH"},{"name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":20,"verticalAlignment":"top"},"id":"7fUpJjIL2DsfQknnq-wa0"},{"name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":20,"verticalAlignment":"top"},"id":"PIPX4pcmcW98Txau_w0mN"},{"name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":20,"verticalAlignment":"top"},"id":"cCTICr9-WCCKgM1zihI3a"},{"name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":20,"verticalAlignment":"top"},"id":"7tcYt28H6ZBQHonx-iXCM"},{"name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":20,"verticalAlignment":"top"},"id":"uu1DjQWXgO_NO5oXOAHWf"}],"params":{"layout":[1],"gap":10,"minHeight":10,"padding":25,"borderRadius":0,"backgroundColor":{"light":"#000000","dark":"#1C2124"},"size":"full"},"id":"w72_YQeLVmnO_3H7W5tTY"}],"name":"section","id":"x_1tr1IPoFQQqIJn_2Jii"},{"id":"xq8go2x2nzRB53Gl6mcmu","params":{"background":{"light":"#ffc40099","dark":"#1d21259999"},"padding":0,"gap":10,"image":{"value":"att21397505","target":"_blank","type":"attachment"}},"children":[{"id":"SwCvX77I8YzeID8el1Ux2","name":"row","children":[{"id":"dZPbWKV2EsN6n_Qs5Y85N","name":"column","children":[{"name":"text","params":{"templateId":"headline and paragraph","value":[{"type":"paragraph","children":[{"type":"paragraph","children":[{"text":"Application Keys","fontWeight":700,"letterSpacing":-3,"lineHeight":"64px","color":{"light":"#000000","dark":"#ffffff"},"fontFamily":"unset","fontSize":48}],"align":"center"}]}]},"children":[],"id":"0TtmjnO-f4xz9ArW2UWHv"}],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":40,"verticalAlignment":"top"}},{"id":"5gTC-wLx6Abt7H_z-FUDj","name":"column","children":[{"name":"image","params":{"templateId":"full-width","alignment":"center","position":"center center","borderRadius":{"all":10,"bbl":0,"bbr":0,"btl":0,"btr":0,"isIndividualCorners":false},"image":{"value":"https://images.unsplash.com/photo-1524758631624-e2822e304c36?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3wzMzg3MzF8MHwxfHNlYXJjaHw4fHxPZmZpY2V8ZW58MHx8fHwxNjkzNTYzNzQ1fDA&ixlib=rb-4.0.3&q=80&w=1080","target":"_self","type":"link"}},"children":[],"id":"I9mL3DVNDAKTji5vQM2F7"}],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":40,"verticalAlignment":"top"}},{"id":"sJ_W6Nh8Xt4FguMmSMhQR","name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":40,"verticalAlignment":"top"}},{"id":"YrSohHBn4-xI7LMUQezzu","name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":40,"verticalAlignment":"top"}},{"id":"3pjGIxBYtledL6ItUdDL8","name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":40,"verticalAlignment":"top"}},{"id":"m8F56VGx_TDGDmXAo3-XI","name":"column","children":[],"params":{"borderRadius":{"all":0,"btl":0,"bbl":0,"btr":0,"bbr":0,"isIndividualCorners":false},"padding":0,"gap":40,"verticalAlignment":"top"}}],"params":{"layout":[1],"gap":100,"minHeight":100,"padding":10,"borderRadius":0}}],"name":"section"}]}
We are aware that when using some browser versions to create App Keys the Demo Tool throws an UNEXPECTED_ERROR when requesting createDeveloperAppKeys. Using an alternative browser/s should resolve this problem.

  • The Application Name cannot contain your username. An UNEXPECTED_ERROR will be returned in these circumstances..

Table of Content Zone
minLevel1
maxLevel2
indent30px
typeflat
separatorpipe

What is an Application Key?

In order to use the Betting & Accounts API, you need to have an Application Key. The Application Key identifies your API client.  Two App Keys are assigned to a single Betfair account, one live App Key and one delayed App Key for testing.

You must pass the Application Key with every HTTP request. You do this by setting the HTTP header with the value of the key assigned by Betfair.

Code Block
X-Application: APP_KEY_ASSIGNED
title
Note

Commercial Usage

Please note: App Key generation is for personal betting purposes only. All data/API usage in any commercial context must be approved by Betfair.

Unauthorised commercial usage will be identified & blocked.

How to Create An Application Key

You can create an Application Key for your Betfair account using the Accounts API Demo Tool and createDeveloperAppKeys operation

  1. Click on theAccounts API Demo Tool

link & ensure the the Endpoint "PROD"/"UK" is selected.  

  1. link 

  2. Select the createDeveloperAppKeys operation from the list of Operations on the top left-hand side of the demo tool.

  3. Enter a sessionToken in the 'Session Token (ssoid)' text box.  You can find instructions on how to find your sessionToken via your browser here.

  4. Enter your Application Name (this must be unique) in the 'Request' column.  The Application Name can be any name of your choice, but like your Betfair username, must be unique.

  5. Press Execute at the bottom of the 'Request' column.

Two Application Keys will then be created and displayed in the Developer Apps column in the demo tool

Please note:

  • The X-Application header is not required when using the createDeveloperAppKeys or the getDeveloperAppKeys service.

  • The Application Name must be unique.

 

Note
Note

You should also ensure that your Application Name is a unique value as attempts to create a duplicate an Application Name that already exists will return an APP_KEY_CREATION_FAILED error response.

How to Retrieve Existing Application Keys

You can only create one set of Application Keys for an account and an error will be displayed if you attempt to create additional Application Keys

To retrieve your existing Application Keys:

  1. Click on theAccounts API Demo Tool link 

  2. Select the getDeveloperAppKeys operation from the list of Operations on the top left-hand side of the demo tool.

  3. Enter a sessionToken in the 'Session Token (ssoid)' text box.  You can find instructions on how to find your sessionToken via your browser here.

  4. Press Execute at the bottom of the 'Request' column.

  5. Details of your existing Application Keys will then appear on the right-hand side under the Developer Apps column.

  6. The Application Key value is shown under the Application Key column. Please note:  You need to expand the Application Key column to see the full Application Key value which is 16 characters in total. 

Live & Delayed Application Keys Usage

The createDeveloperAppKeys service will assign two Application Keys (App Keys) to your Betfair account.

One 'Live' Application Key and one 'Delayed' Application Key. A Delayed Application Key is displayed as 'Version 1.0-DELAY' via createDeveloperAppKeys/getDeveloperAppKeys

Key points:

  • Upon creation, the Live Application Key will be inactive.

  • The Delayed App Key operates on the live (production) Betfair Exchange and not a testbed/sandbox environment.

  • The Delayed App Key should be use for development purposes and any functional testing.  The key provides delayed Betfair price data. The delay is variable between 1-180 second snapshots.

  • The Delayed App Key must also be used in simulation/practice applications where the facility to bet into live Betfair markets is not available.

  • The Delayed App Key does not return traded volume data 'totalMatched' or EX_ALL_OFFERS via listMarketBook. 

How do I activate my Live App Key?

To apply for a a Live Application key please  please take note of the below and provide answers to the following information:

Before applying, please:

  • Complete any

    Complete any testing using your Delayed Application key.

  • Ensure that your account has been fully verified in line with our

    KYC

     KYC policy.  Please note:  We do not accept

    licence

    license applications

    from

    from India, Bangledesh, Sri Lanka or the UAE.

  • Check that your account is funded to cover the £299 activation fee.  

Please note: A  A one-off activation fee of of £299 applies applies; this is debited directly from your Betfair account once access is approved.  

To apply for a a Live Application key please contact Developer Support and provide ALL of the following information:

  • Please describe why you need access to the API*
  • Have you completed your coding and testing using the Delayed App Key? *
  • What sports and markets will you bet into? *
  • Of the markets you read, what percentage do you expect to place bets in? *
  • What number of bets will you place per market? *
  • Your anticipated monthly betting volume? *
  • Do you work for or on behalf of a betting operator or any supplier to a betting operator, or have you in the past? If yes, please provide full details. *
  • Where did you hear about the Betfair API? *
  • Confirm that your App Key and access is for my own private use for the purpose of betting on the Betfair Exchange. This access will not be used in any commercial context
InfoDetailed Historical Data is additionally

 for personal betting use please click here and select Exchange API > For My Personal Betting and complete the application form at the bottom of the page.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#B3D4FF

Detailed Historical Data is made available for testing and analysis purposes.

Personal Betting Access - Application Key

Restrictions will be applied to 'read-only' Live Application Keys.

Delay & Live Application Keys Overview
Anchor
PBA
PBA

Please see below table for a summary of the data/services available to Delayed & Live Application Keys.

 


Delayed Application Key

Live Application Key

Use For

Development

Live betting applications

Activation Fee

None

£299

Live Price Data

Delayed*

Yes

Read Only Access Allowed

Yes

No**

Bet Placement (Live Exchange)

Yes

Yes

Stream API

Yes

(contact Developer Support)

***

Yes

(on application)

Price Levels

3

All

Total Matched by Selection

Not Available

Yes

Total Matched by Market

Yes

Yes

BSP Far & Near Price

Not Available

Yes

Transaction Charge Applies

Yes 

 *Delay is variable between 1-180 seconds
  

Commercial Licensing

Warning
Please note:  We do not accept licence applications from India, Bangledesh, Sri Lanka or the UAE

There are a number of different Commercial API licences available and these fit into the definitions below:

Software Vendor Licence 

  • We wish to create a betting app to distribute to Betfair customers. 

Please see Developer Support for further information on how to apply for a Software Vendor Licence.

Odds Publisher Licence 

  • We are a Betfair Affiliate & want to publish Betfair odds. 

If your not an Affiliate, you can apply via https://affiliates.betfair.com/ > Join Now

Betting Operator Licence 

  • We are a licensed Betting Operator wanting to use Exchange data.  
Please contact us via Developer Support for further information.

(see here)

Yes (see here) 

  • *Delay for app keys can range from 1 to 180 seconds.

  • Restrictions are imposed on 'read only' Live App Keys. Any

  • Delayed App Keys created after April 8, 2020, have default access to the Stream API. For other cases, developers need to contact our Developer Support team for access.