Type definitions
Application subscription details
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionToken | String |
| Application key identifier |
expiryDateTime | Date | Subscription Expiry date | |
expiredDateTime | Date | Subscription Expired date | |
createdDateTime | Date | Subscription Create date | |
activationDateTime | Date | Subscription Activation date | |
cancellationDateTime | Date | Subscription Cancelled date | |
subscriptionStatus | Subscription status | ||
| clientReference | String | Client reference | |
| vendorClientId | String | Vendor client Id |
Application subscription history details
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionToken | String |
| Application key identifier |
expiryDateTime | Date | Subscription Expiry date | |
expiredDateTime | Date | Subscription Expired date | |
createdDateTime | Date | Subscription Create date | |
activationDateTime | Date | Subscription Activation date | |
cancellationDateTime | Date | Subscription Cancelled date | |
subscriptionStatus | Subscription status | ||
| clientReference | String | Client reference |
Application subscription details
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionTokens | List< SubscriptionTokenInfo > |
| Lis t of subscription token details |
applicationName | String | Application name | |
applicationVersionId | String | Application version Id |
Subscription token information
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionToken | String |
| Subscription token |
activatedDateTime | Date | Subscription Activated date | |
expiryDateTime | Date | Subscription Expiry date | |
expiredDateTime | Date | Subscription Expired date | |
cancellationDateTime | Date | Subscription Cancelled date | |
subscriptionStatus | Subscription status |
Describes developer/vendor specific application
Field name | Type | Required | Description |
|---|---|---|---|
appName | String |
| The unique name of the application |
appId | long |
| A unique id of this application |
appVersions | List< DeveloperAppVersion > |
| The application versions (including application keys) |
Describes a version of an external application
Field name | Type | Required | Description |
|---|---|---|---|
owner | String |
| The sportex user who owns the specific version of the application |
versionId | long |
| The unique Id of the application version |
version | String |
| The version identifier string such as 1.0, 2.0. Unique for a given application. |
applicationKey | String |
| The unqiue application key associated with this application version |
delayData | boolean |
| Indicates whether the data exposed by platform services as seen by this application key is delayed or realtime. |
subscriptionRequired | boolean |
| Indicates whether the application version needs explicit subscription |
ownerManaged | boolean |
| Indicates whether the application version needs explicit management by producers. A value of false indicates, this is a version meant for developer use. |
active | boolean |
| Indicates whether the application version is currently active |
Response for retrieving available to bet.
Field name | Type | Required | Description |
|---|---|---|---|
availableToBetBalance | double | Amount available to bet. | |
exposure | double | Current exposure. | |
retainedCommission | double | Sum of retained commission. | |
exposureLimit | double | Exposure limit. | |
discountRate | double | User Discount Rate. | |
| pointsBalance | int | The Betfair points balance |
Response for Account details.
Field name | Type | Required | Description |
|---|---|---|---|
currencyCode | String | Default user currency Code. | |
firstName | String | First Name. | |
lastName | String | Last Name. | |
localeCode | String | Locale Code. | |
region | String | Region. | |
timezone | String | User Time Zone. | |
discountRate | double | User Discount Rate. | |
pointsBalance | int | The Betfair points balance. |
A container representing search results.
Field name | Type | Required | Description |
|---|---|---|---|
accountStatement | List<StatementItem> |
| The list of statement items returned by your request. |
moreAvailable | boolean |
| Indicates whether there are further result items beyond this page. |
Summary of a cleared order.
Field name | Type | Required | Description |
|---|---|---|---|
refId | String |
| An external reference, eg. equivalent to betId in the case of an exchange bet statement item. |
itemDate | Date |
| The date and time of the statement item, eg. equivalent to settledData for an exchange bet statement item. (in ISO-8601 format, not translated) |
amount | double |
| The amount of money the balance is adjusted by |
balance | double |
| Account balance. |
itemClass |
| Class of statement item. This value will determine which set of keys will be included in itemClassData | |
itemClassData | Map<String,String> |
| Key value pairs describing the current statement item. The set of keys will be determined by the itemClass |
legacyData |
| Set of fields originally returned from APIv6. Provided to facilitate migration from APIv6 to API-NG, and ultimately onto itemClass and itemClassData |
Summary of a cleared order.
Field name | Type | Required | Description |
|---|---|---|---|
avgPrice | double |
|
|
betSize | double |
|
|
betType | String |
|
|
betCategoryType | String |
|
|
commissionRate | String |
|
|
eventId | long |
|
|
eventTypeId | long |
|
|
fullMarketName | String |
|
|
grossBetAmount | double |
|
|
marketName | String |
|
|
marketType | String |
|
|
placedDate | Date |
|
|
selectionId | long |
|
|
selectionName | String |
|
|
startDate | Date |
|
|
transactionType | String |
|
|
transactionId | long |
|
|
winLose | String |
|
|
TimeRange
Field name | Type | Required | Description |
|---|---|---|---|
from | Date |
| from, format: ISO 8601) |
to | Date |
| to, format: ISO 8601 |
Currency rate
Field name | Type | Required | Description |
|---|---|---|---|
currencyCode | String |
| Three letter ISO 4217 code |
rate | double |
| Exchange rate for the currency specified in the request |