List markets

listMarkets

curl --request GET \
  --url http://127.0.0.1:9113/v1/markets \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('http://127.0.0.1:9113/v1/markets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9113",
  CURLOPT_URL => "http://127.0.0.1:9113/v1/markets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://127.0.0.1:9113/v1/markets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:9113/v1/markets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "market": {
        "family": "1x2",
        "id": 4503599627370496,
        "name": "<string>",
        "period": "full_time",
        "settlement_rule": "<string>",
        "sport_id": 4503599627370496,
        "line_quarters": 123,
        "participant_id": 4503599627370496
      },
      "outcomes": [
        {
          "code": "home",
          "id": 4503599627370496,
          "market_id": 4503599627370496,
          "name": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "consistency": "<string>",
    "count": 123,
    "next_cursor": "<string>",
    "request_id": "<string>",
    "sent_ts": "2023-11-07T05:31:56Z",
    "snapshot_ts": "2023-11-07T05:31:56Z",
    "version": "<string>",
    "namespace": "<string>"
  },
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ]
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

listMarkets

curl --request GET \
  --url http://127.0.0.1:9113/v1/markets \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('http://127.0.0.1:9113/v1/markets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9113",
  CURLOPT_URL => "http://127.0.0.1:9113/v1/markets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://127.0.0.1:9113/v1/markets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:9113/v1/markets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "market": {
        "family": "1x2",
        "id": 4503599627370496,
        "name": "<string>",
        "period": "full_time",
        "settlement_rule": "<string>",
        "sport_id": 4503599627370496,
        "line_quarters": 123,
        "participant_id": 4503599627370496
      },
      "outcomes": [
        {
          "code": "home",
          "id": 4503599627370496,
          "market_id": 4503599627370496,
          "name": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "consistency": "<string>",
    "count": 123,
    "next_cursor": "<string>",
    "request_id": "<string>",
    "sent_ts": "2023-11-07T05:31:56Z",
    "snapshot_ts": "2023-11-07T05:31:56Z",
    "version": "<string>",
    "namespace": "<string>"
  },
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ]
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "invalid_params": [
    {
      "name": "<string>",
      "reason": "<string>"
    }
  ],
  "missing": [
    {
      "detail": "<string>",
      "reason": "<string>",
      "family": "1x2",
      "fixture_id": 4503599627370496,
      "quote_key": "<string>",
      "source_id": 4503599627370496
    }
  ],
  "request_id": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

Private local pilot with account-wide included credits. Namespace-scoped IDs; overage off. Successful data pages cost one credit; account/errors/304/aborted or timed-out deliveries are free. No payment or source distribution rights are implied. GET /v1/markets

Authentication

ApiKey

Parameters

Name	Location	Required	Description
`namespace`	query	Yes	Explicit pilot namespace; numeric IDs are scoped to it.
`limit`	query	No	Page size 1..100; default 25.
`cursor`	query	No	Opaque query-bound cursor; restart on 409 after data changes.
`sport`	query	No	Comma-separated sport IDs.
`markets`	query	No	Families: 1x2,total,asian_handicap.
`period`	query	No	Market period.
`If-None-Match`	header	No	Weak semantic ETag; freshness and access are revalidated before 304.

Responses

Status	Meaning
200	A typed page. Each successful data page costs one included credit, including explicit missing/insufficient states; account introspection is free. missing[] covers the full query.
304	Semantically unchanged after authentication and eligibility validation; always zero credits, including at exhausted quota.
400	Structured problem; see error handling.
401	Structured problem; see error handling.
402	Structured problem; see error handling.
403	Structured problem; see error handling.
404	Structured problem; see error handling.
405	Structured problem; see error handling.
409	Structured problem; see error handling.
414	Structured problem; see error handling.
422	Structured problem; see error handling.
429	Structured problem; see error handling.
500	Structured problem; see error handling.
503	Structured problem; see error handling.
504	Structured problem; see error handling.

Full request and response schemas: OpenAPI. Authentication · Prices and coverage · Errors and credits.

Authorizations

X-API-Key

string

header

required

Headers

If-None-Match

string

Weak semantic ETag; freshness and access are revalidated before 304.

Query Parameters

namespace

string

required

Explicit pilot namespace; numeric IDs are scoped to it.

limit

integer

default:25

Page size 1..100; default 25.

Required range: 1 <= x <= 100

cursor

string

Opaque query-bound cursor; restart on 409 after data changes.

sport

string

Comma-separated sport IDs.

markets

string

Families: 1x2,total,asian_handicap.

period

enum<string>

Market period.

Available options:

full_time,

first_half

Response

A typed page. Each successful data page costs one included credit, including explicit missing/insufficient states; account introspection is free. missing[] covers the full query.

data

object[]

required

Show child attributes

Start building

Guides

REST v1 reference

History reference

Account and control reference

Authentication

Parameters

Responses

Authorizations

Headers

Query Parameters

Response

​Authentication

​Parameters

​Responses

Authorizations

Headers

Query Parameters

Response

Authentication

Parameters

Responses