Page Comparison

...

...

Appanvil karma designer

summary

Home | API Status | Historical Data | Vendor Program | Developer Forum Navigation Data For Applications

page

Table of Contents

maxLevel	6
minLevel	1
include
outline	false
indent
exclude
type	flat
printable	true
class
separator	pipe

Anchor
Endpoint
Endpoint
Endpoint & Required Headers

This Navigation Data for Applications service allows the retrieval of the full Betfair market navigation menu from a compressed file.

Exchange	HTTP Method	Endpoint
UK	GET	h ttps://api.betfair.com/exchange/betting/rest/v1/en/navigation/menu.json
ITALY	GET	h ttps://api.betfair.it/exchange/betting/rest/v1/

en

it/navigation/menu.json
SPAIN	GET	h ttps://api.betfair.es/exchange/betting/rest/v1/

en

es/navigation/menu.json

title

Info

Best Practice

The file data is cached and new request for the file once an hour should be suitable for those looking to accurately recreate the Betfair navigation menu.

...

The following request headers are required:

X-Application - Your Application Key
X-Authentication - Your session token, obtained from the API login response.

Anchor
Example
Example
Example Request

...

Code Block

GET https://api.betfair.com/exchange/betting/rest/v1/en/navigation/menu.json
Connection: keep-alive
X-Application: <AppKey>
X-Authentication: <SessionToken>
Accept: application/json
Accept-Encoding: gzip,deflate

Anchor
Supported
Supported
Supported Locales

The following languages are supported by the navigation file:

en | en_GB | da | de | es | it | pt | ru | sv

English - en

Spanish - es

Italian - it

German - de

Swedish - sv

Portuguese -pt

Russian - ru

Danish - da

Anchor
Structure.
Structure.
Navigation Data File Structure

This is a diagram showing how the Navigation Data File is structured.

Image Removed

...

A ROOT group node has one or many EVENT_TYPE nodes
...

Anchor
JSONModel
JSONModel
JSON Model Structure

Anchor
ROOT
ROOT
ROOT

...

{

"children": [

{

...

EVENT_TYPE1

},

{

...

EVENT_TYPE2

},

...

],

"id": 0, // always 0

"name": "ROOT", // always ROOT

"type": "GROUP" // always GROUP

}

...

Anchor
EVENTTYPE
EVENTTYPE
EVENT_TYPE

...

`{`
    `"children": [`
        `{`
...
            `GROUP or EVENT or RACE (RACE only if` `Greyhounds/Horse Racing)`
        `},`
        `...`
    `],`
    `"id": "1", // Betfair specific eventTypeId`
    `"name": "Soccer",`
    `"type": "EVENT_TYPE"`
`}`

Anchor
GROUP
GROUP
GROUP

...

...
`{`
    `"children": [`
        `{`
...
            `GROUP or EVENT`
        `},`
        `...`
    `],`
    `"id": "74568202414", // Not a Betfair specific id, different for every GROUP`
    `"name": "Womens Soccer",`
    `"type": "GROUP"`
`}`
...

Anchor
EVENT
EVENT
EVENT

...

`{`
    `"children": [`
        `{`
...
            `GROUP, MARKET or EVENT`
        `},`
        `...`
    `],`
    `"id": "27244118", // Betfair specific eventId`
    `"name": "South Korea U20 (W) v Mexico U20 (W)",`
    `"countryCode": "GB",`
    `"type": "EVENT"`
`}`
...

RACE
Anchor
RACE
RACE

...

{

"children": [

{

...

MARKET

},

...

],

"id": "27247020.1115", // Betfair specific raceId

"name": "1300m 3yo",

"startTime": "2014-08-12T11:15:00.000Z",

"type": "RACE",

"venue": "Deauville",

"raceNumber" : "R1", // US specific information about race numbers

"countryCode": "GB"

}

Anchor
MARKET
MARKET
MARKET

{

"exchangeId": "1", // Betfair specific exchangeId

"id": "1.114881860", // Betfair specific marketId

"marketStartTime": "2014-08-14T00:00:00.000Z", // Betfair specific marketStartTime

"marketType": "WIN", // Betfair specific marketType (e.g. PLACE, WIN, FORECAST etc.)

"numberOfWinners": "2", // Betfair specific number of winners

"name": "Over/Under 6.5 Goals",

"type": "MARKET"

}

...

Versions Compared

Old Version 34

New Version Current

Key

Anchor
Endpoint
Endpoint
Endpoint & Required Headers

Best Practice

Anchor
Example
Example
Example Request

Code Block
GET https://api.betfair.com/exchange/betting/rest/v1/en/navigation/menu.json Connection: keep-alive X-Application: <AppKey> X-Authentication: <SessionToken> Accept: application/json Accept-Encoding: gzip,deflate

Anchor
Supported
Supported
Supported Locales

Anchor
Structure.
Structure.
Navigation Data File Structure

A ROOT group node has one or many EVENT_TYPE nodes
...

Anchor
JSONModel
JSONModel
JSON Model Structure

Anchor
ROOT
ROOT
ROOT

Anchor
EVENTTYPE
EVENTTYPE
EVENT_TYPE

`{`
    `"children": [`
        `{`
...
            `GROUP or EVENT or RACE (RACE only if` `Greyhounds/Horse Racing)`
        `},`
        `...`
    `],`
    `"id": "1", // Betfair specific eventTypeId`
    `"name": "Soccer",`
    `"type": "EVENT_TYPE"`
`}`

Anchor
GROUP
GROUP
GROUP

...
`{`
    `"children": [`
        `{`
...
            `GROUP or EVENT`
        `},`
        `...`
    `],`
    `"id": "74568202414", // Not a Betfair specific id, different for every GROUP`
    `"name": "Womens Soccer",`
    `"type": "GROUP"`
`}`
...

Anchor
EVENT
EVENT
EVENT

`{`
    `"children": [`
        `{`
...
            `GROUP, MARKET or EVENT`
        `},`
        `...`
    `],`
    `"id": "27244118", // Betfair specific eventId`
    `"name": "South Korea U20 (W) v Mexico U20 (W)",`
    `"countryCode": "GB",`
    `"type": "EVENT"`
`}`
...

RACE
Anchor
RACE
RACE

Anchor
MARKET
MARKET
MARKET

Page Comparison

Versions Compared

Old Version 34

New Version Current

Key

AnchorEndpointEndpointEndpoint & Required Headers

Best Practice

AnchorExampleExampleExample Request

Code BlockGET https://api.betfair.com/exchange/betting/rest/v1/en/navigation/menu.json Connection: keep-alive X-Application: <AppKey> X-Authentication: <SessionToken> Accept: application/json Accept-Encoding: gzip,deflate

AnchorSupportedSupportedSupported Locales

AnchorStructure.Structure.Navigation Data File Structure

A ROOT group node has one or many EVENT_TYPE nodes...

AnchorJSONModelJSONModelJSON Model Structure

AnchorROOTROOTROOT

AnchorEVENTTYPEEVENTTYPEEVENT_TYPE

{ "children": [ {... GROUP or EVENT or RACE (RACE only if Greyhounds/Horse Racing) }, ... ], "id": "1", // Betfair specific eventTypeId "name": "Soccer", "type": "EVENT_TYPE"}

AnchorGROUPGROUPGROUP

...{ "children": [ {... GROUP or EVENT }, ... ], "id": "74568202414", // Not a Betfair specific id, different for every GROUP "name": "Womens Soccer", "type": "GROUP"}...

AnchorEVENTEVENTEVENT

{ "children": [ {... GROUP, MARKET or EVENT }, ... ], "id": "27244118", // Betfair specific eventId "name": "South Korea U20 (W) v Mexico U20 (W)", "countryCode": "GB", "type": "EVENT"}...

RACE AnchorRACERACE

AnchorMARKETMARKETMARKET

Anchor
Endpoint
Endpoint
Endpoint & Required Headers

Anchor
Example
Example
Example Request

Code Block
GET https://api.betfair.com/exchange/betting/rest/v1/en/navigation/menu.json Connection: keep-alive X-Application: <AppKey> X-Authentication: <SessionToken> Accept: application/json Accept-Encoding: gzip,deflate

Anchor
Supported
Supported
Supported Locales

Anchor
Structure.
Structure.
Navigation Data File Structure

A ROOT group node has one or many EVENT_TYPE nodes
...

Anchor
JSONModel
JSONModel
JSON Model Structure

Anchor
ROOT
ROOT
ROOT

Anchor
EVENTTYPE
EVENTTYPE
EVENT_TYPE

`{`
`"children": [`
`{`
...
`GROUP or EVENT or RACE (RACE only if` `Greyhounds/Horse Racing)`
`},`
`...`
`],`
`"id": "1", // Betfair specific eventTypeId`
`"name": "Soccer",`
`"type": "EVENT_TYPE"`
`}`

Anchor
GROUP
GROUP
GROUP

...
`{`
`"children": [`
`{`
...
`GROUP or EVENT`
`},`
`...`
`],`
`"id": "74568202414", // Not a Betfair specific id, different for every GROUP`
`"name": "Womens Soccer",`
`"type": "GROUP"`
`}`
...

Anchor
EVENT
EVENT
EVENT

`{`
`"children": [`
`{`
...
`GROUP, MARKET or EVENT`
`},`
`...`
`],`
`"id": "27244118", // Betfair specific eventId`
`"name": "South Korea U20 (W) v Mexico U20 (W)",`
`"countryCode": "GB",`
`"type": "EVENT"`
`}`
...

RACE
Anchor
RACE
RACE

Anchor
MARKET
MARKET
MARKET