List every market key and which period it carries

GET

/v1/markets

const url = 'https://oddslink.app/v1/markets';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://oddslink.app/v1/markets \
  --header 'X-API-Key: <X-API-Key>'

Every market key we serve, its family (the key without a period suffix), which period that specific key carries, and, where known, which books offer it. This is where totals_f5 is documented as “totals, first 5 innings” instead of you having to guess from the suffix.

Authorizations

ApiKeyAuth

Responses

200

Every market key.

application/json

Array<object>

object

key

required

The market key exactly as it appears in markets[].key, suffix included.

string

family

required

The key with its period suffix removed.

string

period

required

The period this key carries: full, h1, h2, q1..q4, or f5 (baseball first 5 innings). There are no F3 or F7 markets.

string

description

required

string

bookmakers

Book keys known to offer this market. Omitted where we have not measured it.

Array<string>

Examples

markets

A full-game market, a period market and a prop

[
  {
    "key": "h2h",
    "family": "h2h",
    "period": "full",
    "description": "Moneyline / match winner."
  },
  {
    "key": "spreads_h1",
    "family": "spreads",
    "period": "h1",
    "description": "Point spread, first half."
  },
  {
    "key": "totals_f5",
    "family": "totals",
    "period": "f5",
    "description": "Total runs, first 5 innings (baseball only)."
  },
  {
    "key": "player_pass_yds",
    "family": "player_pass_yds",
    "period": "full",
    "description": "Player passing yards (prop; see /v1/sports/{sport}/props).",
    "bookmakers": [
      "betmgm",
      "betrivers",
      "bovada",
      "hardrock"
    ]
  }
]

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

400

A parameter was malformed.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "commenceTimeFrom is not a valid ISO-8601 timestamp.",
    "docs_url": "https://oddslink.app/docs/errors/#bad-request",
    "request_id": "req_01hz8k3z9e2v6w1x"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

401

The API key (or session) is missing or invalid.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Examples

No X-API-Key header sent

{
  "error": {
    "code": "MISSING_KEY",
    "message": "X-API-Key header is missing.",
    "docs_url": "https://oddslink.app/docs/errors/#missing-key",
    "request_id": "req_01hz8k4a1f3w7x2y"
  }
}

Key does not exist or was revoked

{
  "error": {
    "code": "INVALID_KEY",
    "message": "API key is not valid.",
    "docs_url": "https://oddslink.app/docs/errors/#invalid-key",
    "request_id": "req_01hz8k4b2g4x8y3z"
  }
}

No Authorization: Bearer header sent (account endpoints only)

{
  "error": {
    "code": "MISSING_SESSION",
    "message": "Sign in and try again.",
    "docs_url": "https://oddslink.app/docs/errors/#missing-session",
    "request_id": "req_01hz8k4b9h5y0z1a"
  }
}

Session is expired or invalid (account endpoints only)

{
  "error": {
    "code": "INVALID_SESSION",
    "message": "Your session has expired. Sign in again.",
    "docs_url": "https://oddslink.app/docs/errors/#invalid-session",
    "request_id": "req_01hz8k4c0j6z1a2b"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

429

The plan’s speed limit was exceeded; wait Retry-After seconds. A call that does not count against the allowance is never refused for a spent allowance.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "SPEED_LIMIT",
    "message": "Speed limit exceeded: 10 requests/second on the Growth plan.",
    "docs_url": "https://oddslink.app/docs/errors/#speed-limit",
    "request_id": "req_01hz8k4f7m9c3d8f"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

Retry-After

integer

Seconds to wait before retrying (429 SPEED_LIMIT only).

5XX

Something failed on our side.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Something went wrong on our side. It has been logged.",
    "docs_url": "https://oddslink.app/docs/errors/#internal-error",
    "request_id": "req_01hz8k4h8n0d4e9f"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.