Skip to content
PredictefyPredictefy Docs
SupportDashboard

API ReferenceSports

Fetch recorded price history for one fixture block.

GET
/v1/sports/fixtures/{fixtureId}/history
curl --request GET \
  --url 'https://data.predictefy.com/v1/sports/fixtures/example/history?marketType=moneyline&period=full&lineTeam=team1&interval=1m' \
  --header 'Authorization: Bearer <token>'

DARK by default. Public access requires both READS_ENABLE_SPORTS and READS_ENABLE_SPORTS_HISTORY to be the literal true, with configured sports Redis and History database clients. A disabled history flag or missing sports Redis client leaves the route unmounted (404). Enabling history without HISTORY_DATABASE_URL rejects service startup. When only the family flag is off, configured beta accounts can access the mounted route; other callers receive 404. Served from the History database, with fixture identity from the mirror or Core when no longer active. priceBasis is best_ask. Samples are retained 90 days; opening and closing marks are permanent once taken. Sample-backed fields (lines, the series[].open fallback, current and movement.changes) consider samples newer than to minus 32 days, the read horizon. The closing block is the recorded kickoff state, not a current quote or an official result. net is non-null only when feeUnknown is false and a net price is available; unknown fees keep net null. Metered at the history weight (sports_history). No ETag, 304, pagination or live venue calls. Recorder liveness failures preserve retained history with degraded metadata; History read failures return HISTORY_UNAVAILABLE. line and venues filter sample-backed data; permanent opening and closing marks can still contribute series for other lines and venues. data.lines lists retained sample lines, so mark-only lines may be absent from that list. Example uses marketType=spread, venues=polymarket and the explicit window in meta before kickoff.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
fixtureId
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]{1,128}$/

Canonical mirrored fixture ID. Invalid characters or more than 128 characters return VALIDATION_ERROR.

Query Parameters

Section titled “Query Parameters”
marketType
string
default: moneyline
Allowed values: moneyline match_result spread total team_total btts halftime_result

Screenable market type.

period
string
default: full >= 1 characters <= 32 characters /^[a-z0-9_]{1,32}$/

Canonical market period.

lineTeam
string
default: team1
Allowed values: team1 team2

Allowed only when marketType=team_total; otherwise 400. team1 is home when both home/away identities are stated, else teamA. Spread always addresses team1 without this parameter. The default applies only to team totals.

line
number

Finite numeric line. When supplied, filters retained samples to this line. Omission selects the latest recorded main line; data.lines lists the available retained sample lines. Permanent opening and closing marks can still contribute series for other lines and venues. Spread lines address team1; line-less markets retain null.

venues
string

Comma-separated display venues. Lowercased, trimmed and deduplicated before enforcing at most 12 distinct venues; each normalized name is 1..32 letters, digits or underscores. Omission uses all available venues.

from
string format: date-time

ISO-8601 instant with seconds and timezone; YYYY-MM-DD is also accepted as UTC midnight. Defaults to the resolved to minus 7 days. Must be strictly before to. An earlier retained sample may anchor the first point at from.

to
string format: date-time

ISO-8601 instant with seconds and timezone; YYYY-MM-DD is also accepted as UTC midnight. Defaults to the earlier of now and exact kickoff plus 12 hours, or now when kickoff is not exact. Explicit future values are capped at now. Must be strictly after from, with a span at most 31 days. The sample read horizon starts at the resolved to minus 32 days.

interval
string
Allowed values: 1m 5m 15m 1h 6h 1d

Sampling bucket width. Omission picks the finest supported interval for which ceil((to - from) / interval) is at most 1000. An explicit finer interval answers 400 VALIDATION_ERROR. Each bucket retains its last recorded state; no future points are manufactured.

Responses

Section titled “Responses”

200

Section titled “200”

Retained fixture price history.

Media typeapplication/json
object
success
required
boolean
data
required

Recorded best-ask history from the History database. Samples are retained 90 days; opening and closing marks are kept forever. The closing block is the recorded kickoff state, not a current quote or an official result. It is null when kickoff is not exact, the window ends before kickoff, or no closing samples exist. final means the keyed markets closed. Fair, edge and hold are Predictefy calculations.

object
fixtureId
required
string
sport
required
string
competition
required
object
id
required
string
name
required
string
timeZone
required
string | null
home
required
Any of:
object
id
required
string
name
required
string
away
required
Any of:
object
id
required
string
name
required
string
teams
required
Array<object>
>= 2 items <= 2 items
object
id
required
string
name
required
string
kickoffAt
required
string | null format: date-time
kickoffPrecision
required
string
Allowed values: exact date
eventDate
required
string format: date
status
required
string
Allowed values: scheduled live final postponed cancelled
marketType
required
string
Allowed values: moneyline match_result spread total team_total btts halftime_result
period
required
string
lineTeam
required
Any of:
object
key
required
string
kind
required
string
Allowed values: team draw over under yes no
side
required
string | null
Allowed values: home away
team
required
Any of:
object
id
required
string
name
required
string
line
required
number | null
lines
required
Array<number | null>
movement
required

Main-line movement in recorded order. open and current are the first and last returned changes; close is the main line reconstructed from the recorded kickoff block, or null when unavailable.

object
open
required
Any of:
object
at
required
string format: date-time
line
required
number | null
current
required
Any of:
object
at
required
string format: date-time
line
required
number | null
close
required
number | null
changes
required
Array<object>
object
at
required
string format: date-time
line
required
number | null
closing
required
Any of:
object
marketType
required
string
Allowed values: moneyline match_result spread total team_total btts halftime_result
period
required
string
line
required
number | null
lineTeam
required
Any of:
object
key
required
string
kind
required
string
Allowed values: team draw over under yes no
side
required
string | null
Allowed values: home away
team
required
Any of:
object
id
required
string
name
required
string
lines
required
Array<object>
object
line
required
number | null
venues
required
Array<string>
hold
required
object
average
required
number | null
byVenue
required
object
key
additional properties
number
selections
required
Array<object>

Predictefy computes average, normalized fair probability, edge, and hold. Edge is null whenever fair is null. Best is an eligible live, non-stale quote or null; unknown fees can select best on gross with edgeOnGross=true and net=null. Best does not promise a verified all-in execution cost.

object
selection
required
object
key
required
string
kind
required
string
Allowed values: team draw over under yes no
side
required
string | null
Allowed values: home away
team
required
Any of:
object
id
required
string
name
required
string
cells
required
Array<object>

One venue quote. Catalog and stale cells cannot be best. feeUnknown=true always has net=null. grossReason explains a null gross price; asOf is the source quote clock, not a freshness confirmation.

object
venue
required
string
marketId
required
string
outcomeId
required
string
selection
required
string
gross
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
grossReason
required
string | null
Allowed values: no_asks book_unavailable synthetic_book market_not_open
net
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
feeBps
required
number | null
feeUnknown
required
boolean
sizeAtPrice
required
number | null
asOf
required
string | null format: date-time
stale
required
boolean
source
required
string
Allowed values: live catalog
best
required
Any of:

One venue quote. Catalog and stale cells cannot be best. feeUnknown=true always has net=null. grossReason explains a null gross price; asOf is the source quote clock, not a freshness confirmation.

object
venue
required
string
marketId
required
string
outcomeId
required
string
selection
required
string
gross
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
grossReason
required
string | null
Allowed values: no_asks book_unavailable synthetic_book market_not_open
net
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
feeBps
required
number | null
feeUnknown
required
boolean
sizeAtPrice
required
number | null
asOf
required
string | null format: date-time
stale
required
boolean
source
required
string
Allowed values: live catalog
avg
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
fair
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
edge
required
number | null
edgeOnGross
required
boolean
closingUnavailable
required
string | null
Allowed values: kickoff_not_exact before_kickoff no_samples
series
required
Array<object>

One venue, selection and line. open is the first usable recorded price; close is the recorded kickoff mark; current is the latest retained state and can fall outside the requested window. Opening and closing marks survive sample retention. points are ordered by at, with an optional anchor at from.

object
venue
required
string
selection
required
object
key
required
string
kind
required
string
Allowed values: team draw over under yes no
side
required
string | null
Allowed values: home away
team
required
Any of:
object
id
required
string
name
required
string
line
required
number | null
open
required
Any of:

At is the recorded point time (or from for an anchor); asOf is source freshness. gross is the recorded best ask, or null with a reason. A non-null net is present only when feeUnknown is false and a net price is available; the net key is always emitted, otherwise null. Catalog and stale states remain explicitly marked.

object
at
required
string format: date-time
asOf
required
string | null format: date-time
gross
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
net
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
feeUnknown
required
boolean
sizeAtPrice
required
number | null
stale
required
boolean
source
required
string
Allowed values: live catalog
reason
required
string | null
Allowed values: no_asks book_unavailable synthetic_book market_not_open removed
marketId
required
string
outcomeId
required
string
close
required
Any of:

At is the recorded point time (or from for an anchor); asOf is source freshness. gross is the recorded best ask, or null with a reason. A non-null net is present only when feeUnknown is false and a net price is available; the net key is always emitted, otherwise null. Catalog and stale states remain explicitly marked.

object
at
required
string format: date-time
asOf
required
string | null format: date-time
gross
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
net
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
feeUnknown
required
boolean
sizeAtPrice
required
number | null
stale
required
boolean
source
required
string
Allowed values: live catalog
reason
required
string | null
Allowed values: no_asks book_unavailable synthetic_book market_not_open removed
marketId
required
string
outcomeId
required
string
current
required
Any of:

At is the recorded point time (or from for an anchor); asOf is source freshness. gross is the recorded best ask, or null with a reason. A non-null net is present only when feeUnknown is false and a net price is available; the net key is always emitted, otherwise null. Catalog and stale states remain explicitly marked.

object
at
required
string format: date-time
asOf
required
string | null format: date-time
gross
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
net
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
feeUnknown
required
boolean
sizeAtPrice
required
number | null
stale
required
boolean
source
required
string
Allowed values: live catalog
reason
required
string | null
Allowed values: no_asks book_unavailable synthetic_book market_not_open removed
marketId
required
string
outcomeId
required
string
points
required
Array<object>

At is the recorded point time (or from for an anchor); asOf is source freshness. gross is the recorded best ask, or null with a reason. A non-null net is present only when feeUnknown is false and a net price is available; the net key is always emitted, otherwise null. Catalog and stale states remain explicitly marked.

object
at
required
string format: date-time
asOf
required
string | null format: date-time
gross
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
net
required
Any of:
object
probability
required
number
> 0 < 1
american
required
number
decimal
required
number
feeUnknown
required
boolean
sizeAtPrice
required
number | null
stale
required
boolean
source
required
string
Allowed values: live catalog
reason
required
string | null
Allowed values: no_asks book_unavailable synthetic_book market_not_open removed
marketId
required
string
outcomeId
required
string
meta
required

Resolved window and sampling interval. truncated is true when the bucketed sample result exceeds the repository row cap. Recorder liveness is advisory: retained prices remain available when degraded. Healthy responses omit degradedReason.

object
asOf
required
string format: date-time
from
required
string format: date-time
to
required
string format: date-time
interval
required
string
Allowed values: 1m 5m 15m 1h 6h 1d
priceBasis
required
string
Allowed value: best_ask
retentionDays
required
integer
Allowed value: 90
truncated
required
boolean
degraded
required
boolean
degradedReason
string | null
Allowed values: recorder_stale recorder_not_writing redis_unavailable
Example
{
  "success": true,
  "data": {
    "fixtureId": "nba-2026-09-29-lal-bos",
    "sport": "basketball",
    "competition": {
      "id": "nba",
      "name": "NBA",
      "timeZone": "America/New_York"
    },
    "home": {
      "id": "los-angeles-lakers",
      "name": "Los Angeles Lakers"
    },
    "away": {
      "id": "boston-celtics",
      "name": "Boston Celtics"
    },
    "teams": [
      {
        "id": "los-angeles-lakers",
        "name": "Los Angeles Lakers"
      },
      {
        "id": "boston-celtics",
        "name": "Boston Celtics"
      }
    ],
    "kickoffAt": "2026-09-29T12:00:00.000Z",
    "kickoffPrecision": "exact",
    "eventDate": "2026-09-29",
    "status": "scheduled",
    "marketType": "spread",
    "period": "full",
    "lineTeam": {
      "key": "home",
      "kind": "team",
      "side": "home",
      "team": {
        "id": "los-angeles-lakers",
        "name": "Los Angeles Lakers"
      }
    },
    "line": -3.5,
    "lines": [
      -3.5
    ],
    "movement": {
      "open": {
        "at": "2026-09-29T11:50:00.000Z",
        "line": -3.5
      },
      "current": {
        "at": "2026-09-29T11:50:00.000Z",
        "line": -3.5
      },
      "close": null,
      "changes": [
        {
          "at": "2026-09-29T11:50:00.000Z",
          "line": -3.5
        }
      ]
    },
    "closing": null,
    "closingUnavailable": "before_kickoff",
    "series": [
      {
        "venue": "polymarket",
        "selection": {
          "key": "home",
          "kind": "team",
          "side": "home",
          "team": {
            "id": "los-angeles-lakers",
            "name": "Los Angeles Lakers"
          }
        },
        "line": -3.5,
        "open": {
          "at": "2026-09-29T11:50:00.000Z",
          "asOf": "2026-09-29T11:50:00.000Z",
          "gross": {
            "probability": 0.5,
            "american": 100,
            "decimal": 2
          },
          "net": {
            "probability": 0.5,
            "american": 100,
            "decimal": 2
          },
          "feeUnknown": false,
          "sizeAtPrice": 100,
          "stale": false,
          "source": "live",
          "reason": null,
          "marketId": "1234567",
          "outcomeId": "78018682347280956411283430278314908651872132508462137629544622958167241418531"
        },
        "close": null,
        "current": {
          "at": "2026-09-29T11:59:00.000Z",
          "asOf": "2026-09-29T11:56:00.000Z",
          "gross": {
            "probability": 0.5,
            "american": 100,
            "decimal": 2
          },
          "net": null,
          "feeUnknown": true,
          "sizeAtPrice": null,
          "stale": true,
          "source": "catalog",
          "reason": null,
          "marketId": "1234567",
          "outcomeId": "78018682347280956411283430278314908651872132508462137629544622958167241418531"
        },
        "points": [
          {
            "at": "2026-09-29T11:58:00.000Z",
            "asOf": null,
            "gross": {
              "probability": 0.4,
              "american": 150,
              "decimal": 2.5
            },
            "net": {
              "probability": 0.4,
              "american": 150,
              "decimal": 2.5
            },
            "feeUnknown": false,
            "sizeAtPrice": 100,
            "stale": false,
            "source": "live",
            "reason": null,
            "marketId": "1234567",
            "outcomeId": "78018682347280956411283430278314908651872132508462137629544622958167241418531"
          },
          {
            "at": "2026-09-29T11:59:00.000Z",
            "asOf": "2026-09-29T11:56:00.000Z",
            "gross": {
              "probability": 0.5,
              "american": 100,
              "decimal": 2
            },
            "net": null,
            "feeUnknown": true,
            "sizeAtPrice": null,
            "stale": true,
            "source": "catalog",
            "reason": null,
            "marketId": "1234567",
            "outcomeId": "78018682347280956411283430278314908651872132508462137629544622958167241418531"
          }
        ]
      },
      {
        "venue": "polymarket",
        "selection": {
          "key": "away",
          "kind": "team",
          "side": "away",
          "team": {
            "id": "boston-celtics",
            "name": "Boston Celtics"
          }
        },
        "line": -3.5,
        "open": {
          "at": "2026-09-29T11:50:00.000Z",
          "asOf": "2026-09-29T11:50:00.000Z",
          "gross": {
            "probability": 0.5,
            "american": 100,
            "decimal": 2
          },
          "net": {
            "probability": 0.5,
            "american": 100,
            "decimal": 2
          },
          "feeUnknown": false,
          "sizeAtPrice": 100,
          "stale": false,
          "source": "live",
          "reason": null,
          "marketId": "1234567",
          "outcomeId": "43527008401149359855218064713320894673589240180563304811827286256675437092861"
        },
        "close": null,
        "current": {
          "at": "2026-09-29T11:59:00.000Z",
          "asOf": "2026-09-29T11:59:00.000Z",
          "gross": null,
          "net": null,
          "feeUnknown": false,
          "sizeAtPrice": 0,
          "stale": false,
          "source": "live",
          "reason": "no_asks",
          "marketId": "1234567",
          "outcomeId": "43527008401149359855218064713320894673589240180563304811827286256675437092861"
        },
        "points": [
          {
            "at": "2026-09-29T11:59:00.000Z",
            "asOf": "2026-09-29T11:59:00.000Z",
            "gross": null,
            "net": null,
            "feeUnknown": false,
            "sizeAtPrice": 0,
            "stale": false,
            "source": "live",
            "reason": "no_asks",
            "marketId": "1234567",
            "outcomeId": "43527008401149359855218064713320894673589240180563304811827286256675437092861"
          }
        ]
      }
    ]
  },
  "meta": {
    "asOf": "2026-09-29T11:59:30.000Z",
    "from": "2026-09-29T11:55:00.000Z",
    "to": "2026-09-29T11:59:00.000Z",
    "interval": "1m",
    "priceBasis": "best_ask",
    "retentionDays": 90,
    "truncated": false,
    "degraded": false
  }
}

400

Section titled “400”

Invalid query or fixture ID. Facets rejects from/to because its snapshot owns the window.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}

401

Section titled “401”

Missing, invalid or revoked API key.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}

402

Section titled “402”

The account's credit balance cannot cover this sports read's weight. Not retryable.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}

403

Section titled “403”

The API key lacks the read scope this route requires. Not retryable.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}

404

Section titled “404”

The fixture is absent from the mirror, or the family is unmounted.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}

429

Section titled “429”

Request rate limit exceeded.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}

500

Section titled “500”

Unexpected internal error; requestId identifies the failure.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}

503

Section titled “503”

HISTORY_UNAVAILABLE when the History database read fails or exceeds its bounded budget; database timeouts and budget exhaustion are not retryable. Capacity overflow is retryable and includes Retry-After: 1. SPORTS_SCREEN_UNAVAILABLE when the cold engine fixture index cannot load. CATALOG_UNAVAILABLE when the Core identity fallback times out. PLATFORM_UNAVAILABLE when authentication or metering storage is unavailable. Recorder liveness alone instead returns retained history with degraded metadata.

Media typeapplication/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: VALIDATION_ERROR NOT_SUPPORTED ACCOUNTS_UNSUPPORTED VENUE_NOT_AVAILABLE EXCHANGE_NOT_AVAILABLE MARKET_NOT_FOUND EVENT_NOT_FOUND TRADERS_UNSUPPORTED TRADER_NOT_FOUND CLUSTER_NOT_FOUND OUTCOME_NOT_FOUND SNAPSHOT_NOT_FOUND CATALOG_UNAVAILABLE CATALOG_QUERY_TOO_BROAD HISTORY_UNAVAILABLE SPORTS_SCREEN_UNAVAILABLE SPORTS_FIXTURE_NOT_FOUND SPORTS_BLOCK_NOT_FOUND ROUTE_NOT_FOUND INTERNAL AUTHENTICATION_ERROR PERMISSION_DENIED RATE_LIMIT_EXCEEDED NETWORK_ERROR NOT_FOUND BAD_REQUEST BRIDGE_UNSUPPORTED BRIDGE_NO_ROUTE BRIDGE_UPSTREAM BRIDGE_PROVIDER_UNAVAILABLE BRIDGE_TRANSACTION_NOT_FOUND BRIDGE_SESSION_NOT_FOUND TRANSFER_PLAN_UNSUPPORTED UNAUTHORIZED SCOPE_MISSING PLAN_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED GEO_BLOCKED VENUE_REGION_BLOCKED IDEMPOTENCY_KEY_REQUIRED RESERVED_IDEMPOTENCY_KEY IDEMPOTENCY_CONFLICT ARTIFACT_VERSION_CONFLICT SPEND_CAP_EXCEEDED RESERVATION_REQUIRED RESERVATION_CONSUMED RESERVATION_MISMATCH RESERVATION_EXPIRED RESERVATION_RELEASED ARTIFACT_BOUNDS_VIOLATION ARTIFACT_INTEGRITY_MISMATCH CLAIM_GENERATION_UNDETERMINED VENUE_NOT_SUPPORTED EXECUTION_NOT_FOUND EXECUTION_TERMINAL CONDITIONAL_NOT_FOUND CONDITIONAL_NOT_ARMED CONDITIONAL_ATTEMPT_CONFLICT CONDITIONAL_ARMED CONDITIONAL_CLOSED_NOT_SUBMITTED OCO_GROUP_CLOSED HOSTED_FIRE_NOT_ELIGIBLE HOSTED_FIRE_UNAVAILABLE NOT_IMPLEMENTED VENUE_CREDENTIAL_REJECTED VENUE_CREDENTIAL_BREAKER_OPEN GEMINI_TIME_NONCE_REQUIRED GEMINI_HEARTBEAT_KEY_UNSUPPORTED VENUE_RELAY_FAILED EXEC_UNAVAILABLE RAIN_INVALID_OPTION RAIN_INVALID_SIDE RAIN_INVALID_PRICE RAIN_INVALID_AMOUNT RAIN_SLIPPAGE_REQUIRED RAIN_INVALID_DEADLINE RAIN_PHASE_NOT_OPEN RAIN_ORDER_LIMIT_REACHED RAIN_POOL_SAFETY_CHECK_FAILED PLATFORM_UNAVAILABLE PACK_NOT_FOUND BILLING_UNAVAILABLE BILLING_CUSTOMER_REQUIRED PLAN_NOT_FOUND SUBSCRIPTION_EXISTS WEBHOOK_NOT_FOUND INVALID_SIGNATURE PAPER_INSUFFICIENT_CASH PAPER_POSITION_TOO_SMALL PAPER_MARKET_CLOSED PAPER_WORKING_ORDER_CAP PAPER_NO_LIVE_BOOK PAPER_ORDER_NOT_FOUND PAPER_ORDER_NOT_OPEN SQL_QUERY_FAILED SQL_TIMEOUT FEED_NOT_FOUND FEEDS_UNAVAILABLE FEED_UPSTREAM MATCHES_UNAVAILABLE ARBITRAGE_UNAVAILABLE
retryable
required
boolean
requestId
required

Always present on errors; quote this id when reporting a failed request.

string
exchange

Present only when a venue error is attributed to a specific exchange.

string
Example
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR"
  }
}