Versions Compared

Old Version 30

changes.mady.by.user PepikM

Saved on

compared with

New Version 31

changes.mady.by.user Neil Thomas

Saved on

Key

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

...

Interface
Endpoint
<method> Example
JSON-RPC https://api.betfair.es/exchange/heartbeat/json-rpc/v1HeartbeatAPING/v1.0/heartbeat



Operation Summary

HeartbeatReport2687301

heartbeat2687301 ( int preferredTimeoutSeconds )

Detailed documentation

Heartbeat

Operations
Anchor
Operations
Operations

...

Panel
bgColor#FFFFFF
titleBGColor#C8D0E4
titleheartbeat

HeartbeatReport2687301 heartbeat ( int preferredTimeoutSeconds ) throws APINGException2687301

This heartbeat operation is provided to help customers have their positions managed automatically in the event of their API clients losing connectivity with the Betfair API. If a heartbeat request is not received within a prescribed time period, then Betfair will attempt to cancel all 'LIMIT' type bets for the given customer on the given exchange. There is no guarantee that this service will result in all bets being cancelled as there are a number of circumstances where bets are unable to be cancelled. Manual intervention is strongly advised in the event of a loss of connectivity to ensure that positions are correctly managed. If this service becomes unavailable for any reason, then your heartbeat will be unregistered automatically to avoid bets being inadvertently cancelled upon resumption of service. you should manage your position manually until the service is resumed. Heartbeat data may also be lost in the unlikely event of nodes failing within the cluster, which may result in your position not being managed until a subsequent heartbeat request is received.

Parameter name

Type

Required

Description

preferredTimeoutSeconds

int

Maximum period in seconds that may elapse (without a subsequent heartbeat request), before a cancellation request is automatically submitted on your behalf. The minimum value is 10, the maximum value permitted is 300. Passing 0 will result in your heartbeat being unregistered (or ignored if you have no current heartbeat registered). You will still get an actionPerformed value returned when passing 0, so this may be used to determine if any action was performed since your last heartbeat, without actually registering a new heartbeat. Passing a negative value will result in an error being returned, INVALID_INPUT_DATA. Any errors while registering your heartbeat will result in a error being returned, UNEXPECTED_ERROR. Passing a value that is less than the minimum timeout will result in your heartbeat adopting the minimum timeout. Passing a value that is greater than the maximum timeout will result in your heartbeat adopting the maximum timeout. The minimum and maximum timeouts are subject to change, so your client should utilise the returned actualTimeoutSeconds to set an appropriate frequency for your subsequent heartbeat requests.


Return type

Description

HeartbeatReport2687301

Response from heartbeat operation


Throws

Description

APINGException2687301

Thrown if the operation fails


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleHeartbeatReport

Response from heartbeat operation

Field name

Type

Required

Description

actionPerformed

ActionPerformed2687301

The action performed since your last heartbeat request.

actualTimeoutSeconds

int

The actual timeout applied to your heartbeat request, see timeout request parameter description for details.


...

Panel
bgColor#FFFFFF
titleBGColor#E4B8D6
titleAPINGException
This exception is thrown when an operation fails


Error code

Description

INVALID_INPUT_DATA

Invalid input data

INVALID_SESSION_INFORMATION

The session token passed is invalid

NO_APP_KEY

An application key is required for this operation

NO_SESSION

A session token is required for this operation

INVALID_APP_KEY

The application key passed is invalid

UNEXPECTED_ERROR

An unexpected internal error occurred that prevented successful request processing.


Other parameters

Type

Required

Description

errorDetails

String


Specific error details

requestUUID

String

 





Typical Interaction

 

Code Block
titleSetting Up Heartbeat
[{"jsonrpc": "2.0", "method": "HeartbeatAPING/v1.0/heartbeat", "params": {"preferredTimeoutSeconds":"10"}, "id": 1}]
 
 [{"jsonrpc":"2.0","result":{"actualTimeoutSeconds":10,"actionPerformed":"NONE"},"id":1}]


 

Code Block
titleResetting Heartbeat
 [{"jsonrpc": "2.0", "method": "HeartbeatAPING/v1.0/heartbeat", "params": {"preferredTimeoutSeconds":"0"}, "id": 1}]
 
 [{"jsonrpc":"2.0","result":{"actualTimeoutSeconds":0,"actionPerformed":"NONE"},"id":1}]
 

...

Code Block
titleEXAMPLE OF RESPONSE IF HEARTBEAT ISN'T RECEIVED WITHIN SPECIFIED TIME  
[{"jsonrpc": "2.0", "method": "HeartbeatAPING/v1.0/heartbeat", "params": {"preferredTimeoutSeconds":"10"}, "id": 1}]
 
[{"jsonrpc":"2.0","result":{"actualTimeoutSeconds":10,"actionPerformed":"ALL_BETS_CANCELLED"},"id":1}]

 

 

...