Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

The listRaceDetails operation is provided to allow customers to establish the status of a horse race market.

listRaceDetails

Interface

Endpoint

JSON-RPC Prefix

<methodname> Example

JSON-RPC

https://api.betfair.com/exchange/scores/json-rpc/v1

<methodname>

ScoresAPING/v1.0/listRaceDetails

Operation summary

List<RaceDetails>

listRaceDetails ( Set<MeetingId> meetingIds, Set<RaceId> raceIds )

 

Operations

 

listRaceDetails

List<RaceDetails> listRaceDetails ( Set<MeetingId> meetingIds, Set<RaceId> raceIds ) throws APINGException

Search for races to get their details.

Parameter name

Type

Required

Description

meetingIds

Set<MeetingId>

 

Optionally restricts the results to the specified meeting IDs.

raceIds

Set<RaceId>

 

Optionally restricts the results to the specified race IDs.

Return type

Description

List<RaceDetails>

List of retrieved race details

Throws

Description

APINGException

 

Since 1.0.0

 

Events

This interface does not define any events.

Type definitions

RaceDetails

Race Details

Field name

Type

Required

Description

meetingId

MeetingId

The unique Id for the meeting equivalent to the eventId for that specific race as returned by listEvents.  Optionally restricts the results to the specified meeting IDs.

raceId

RaceId

The unique Id for the race in the format meetingid.raceTime (hhmm).  Optionally restricts the results to the specified race IDs.

raceStatus

RaceStatus

The current status of the race.

lastUpdated

LastUpdated

 

This is the time the data was last updated

responseCode

ResponseCode

 

 

 

Enums

RaceStatus

 

Value

Description

DORMANT

There is no data available for this race.

DELAYED

The start of the race has been delayed

PARADING

The horses are in the parade ring

GOINGDOWN

The horses are going down to the starting post

GOINGBEHIND

The horses are going behind the stalls

ATTHEPOST

 The horses are at the post

UNDERORDERS

The horses are loaded into the stalls/race is about to start

OFF

The race has started

FINISHED

The race has finished

FALSESTART

There has been a false start

PHOTOGRAPH

The result of the race is subject to a photo finish

RESULT

The result of the race has been announced

WEIGHEDIN

The jockeys have weighed in

RACEVOID

The race has been declared void

ABANDONED

The meeting has been cancelled

 

ResponseCode

 

Value

Description

OK

Data returned successfully

NO_NEW_UPDATES

No updates since the passes UpdateSequence

NO_LIVE_DATA_AVAILABLE

Event scores are no longer available or are not on the schedule

SERVICE_UNAVAILABLE

Data feed for the event type (tennis/football etc) is currently unavailable

UNEXPECTED_ERROR

An unexpected error occurred retrieving score data

LIVE_DATA_TEMPORARILY_UNAVAILABLE

Live Data feed for this event/match is temporarily unavailable, data could potentially be 
stale

 

 

Exceptions

 

 

APINGException

This exception is thrown when an operation fails

Error code

Description

UNEXPECTED_ERROR

The operation failed with an unexpected error

INVALID_INPUT_DATA

Invalid input data

INVALID_SESSION_INFORMATION

The session token passed is invalid or expired

INVALID_APP_KEY

The application key passed is invalid

SERVICE_BUSY

The service is currently too busy to service this request

TIMEOUT_ERROR

Internal call to downstream service timed out

NO_SESSION

A session token is required for this operation

NO_APP_KEY

An application key is required for this operation

TOO_MANY_REQUESTS

Too many requests

SERVICE_UNAVAILABLE

Service is currently unavailable

Other parameters

Type

Required

Description

errorDetails

String

 

The stack trace of the error

requestUUID

String

 

 

 

Operations

 

listScores

List<Score> listScores ( List<UpdateKey> updateKeys ) throws APINGException

Returns a list of current scores for the given events.

Parameter name

Type

Required

Description

updateKeys

List<UpdateKey>

The filter to select desired markets. All markets that match the criteria in the filter are selected.

Return type

Description

List<Score>

List of retrieved scores

Throws

Description

APINGException

 

Since 1.0.0


 

listIncidents

List<Incidents> listIncidents ( List<UpdateKey> updateKeys ) throws APINGException

Returns a list of incidents for the given events.

Parameter name

Type

Required

Description

updateKeys

List<UpdateKey>

The filter to select desired markets. All markets that match the criteria in the filter are selected.

Return type

Description

List<Incidents>

List of retrieved incidents

Throws

Description

APINGException

 

Since 1.0.0


 

listAvailableEvents

List<AvailableEvent> listAvailableEvents ( Set<EventId> eventIds, Set<EventTypeId> eventTypeIds, Set<EventStatus> eventStatus ) throws APINGException

Search for events that have live score data available.

Parameter name

Type

Required

Description

eventIds

Set<EventId>

 

Optionally restricts the results to the specified event IDs.

eventTypeIds

Set<EventTypeId>

 

Optionally restricts the results to the specified event type IDs.

eventStatus

Set<EventStatus>

 

Optionally restricts the results to the specified event status.

Return type

Description

List<AvailableEvent>

List of retrieved available events

Throws

Description

APINGException

 

Since 1.0.0


 

listRaceDetails

List<RaceDetails> listRaceDetails ( Set<MeetingId> meetingIds, Set<RaceId> raceIds ) throws APINGException

Search for races to get their details.

Parameter name

Type

Required

Description

meetingIds

Set<MeetingId>

 

Optionally restricts the results to the specified meeting IDs.

raceIds

Set<RaceId>

 

Optionally restricts the results to the specified race IDs.

Return type

Description

List<RaceDetails>

List of retrieved race details

Throws

Description

APINGException

 

Since 1.0.0

 

Events

This interface does not define any events.

Type definitions

 

Incidents

Key/Value pairs

Field name

Type

Required

Description

eventId

EventId

 

eventTypeId

EventTypeId

 

 

eventStatus

EventStatus

 

 

responseCode

ResponseCode

 

incidents

Map<long,Incident>

 

 

 

Incident

Key/Value pairs

Field name

Type

Required

Description

updateContext

UpdateContext

 

values

Map<String,String>

 

 

 

 

Score

Key/Value pairs

Field name

Type

Required

Description

eventId

EventId

 

eventTypeId

EventTypeId

 

 

eventStatus

EventStatus

 

 

responseCode

ResponseCode

 

updateContext

UpdateContext

 

values

Map<String,String>

 

 

 

 

AvailableEvent

Available events

Field name

Type

Required

Description

eventId

EventId

 

eventTypeId

EventTypeId

 

eventStatus

EventStatus

 

 

 

RaceDetails

Race Details

Field name

Type

Required

Description

meetingId

MeetingId

 

raceId

RaceId

 

raceStatus

RaceStatus

 

lastUpdated

LastUpdated

 

This is the time the data was last updated

responseCode

ResponseCode

 

 

 

UpdateContext

Update time

Field name

Type

Required

Description

eventTime

EventTime

 

This is the eventTime as at the last updated time, format is event type specific.

lastUpdated

LastUpdated

This is the time the data was last updated

updateSequence

UpdateSequence

This is the unique identifier associated to each update of the data

updateType

UpdateType

This is the type of update

 

 

UpdateKey

Key/Value pairs

Field name

Type

Required

Description

eventId

EventId

 

lastUpdateSequenceProcessed

UpdateSequence

 

Last update processed by client. If not provided, then all data will be returned for the 
event.

 

 

Type aliases

 

Alias

Type

 UpdateSequence

long

 EventId

String

 EventTypeId

String

 EventTime

String

 UpdateType

String

 LastUpdated

Date

 MeetingId

String

 RaceId

String

 

 

Enums

 

EventStatus

 

Value

Description

FINISHED

 

IN_PROGRESS

 

PENDING

 

 

 

RaceStatus

 

Value

Description

DORMANT

 

DELAYED

 

PARADING

 

GOINGDOWN

 

GOINGBEHIND

 

ATTHEPOST

 

UNDERORDERS

 

OFF

 

FINISHED

 

FALSESTART

 

PHOTOGRAPH

 

RESULT

 

WEIGHEDIN

 

RACEVOID

 

ABANDONED

 

 

 

ResponseCode

 

Value

Description

OK

data returned successfully

NO_NEW_UPDATES

No updates since the passes UpdateSequence

NO_LIVE_DATA_AVAILABLE

Event scores are no longer available or are not on the schedule

SERVICE_UNAVAILABLE

Data feed for the event type (tennis/football etc) is currently unavailable

UNEXPECTED_ERROR

An unexpected error occurred retrieving score data

LIVE_DATA_TEMPORARILY_UNAVAILABLE

Live Data feed for this event/match is temporarily unavailable, data could potentially be 
stale

 

 

Exceptions

 

APINGException

This exception is thrown when an operation fails

Error code

Description

UNEXPECTED_ERROR

The operation failed with an unexpected error

INVALID_INPUT_DATA

Invalid input data

INVALID_SESSION_INFORMATION

The session token passed is invalid or expired

INVALID_APP_KEY

The application key passed is invalid

SERVICE_BUSY

The service is currently too busy to service this request

TIMEOUT_ERROR

Internal call to downstream service timed out

NO_SESSION

A session token is required for this operation

NO_APP_KEY

An application key is required for this operation

TOO_MANY_REQUESTS

Too many requests

SERVICE_UNAVAILABLE

Service is currently unavailable

Other parameters

Type

Required

Description

errorDetails

String

 

The stack trace of the error

requestUUID

String