Get market metrics history

GET

markets

{id_or_slug}

metrics

curl --request GET \
  --url https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics",
  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 := "https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics"

	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("https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics")

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

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

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

{
  "data": [
    {
      "liquidity": 45678,
      "spread": 0.015,
      "t": "2025-09-05T10:00:00Z",
      "volume": 1200.5
    },
    {
      "liquidity": 47010,
      "spread": 0.012,
      "t": "2025-09-05T11:00:00Z",
      "volume": 980
    }
  ],
  "market_id": "618831",
  "metadata": {
    "count": 2,
    "limit": 100
  },
  "resolution": "1h"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

id_or_slug

string

required

Market ID or market slug.

Required string length: 1 - 200

Example:

"618831"

Query Parameters

start_ts

string

required

Inclusive range start. Accepts ISO 8601 timestamp or Unix seconds.

Examples:

"2025-09-01T00:00:00Z"

"1756684800"

end_ts

string

required

Exclusive range end. Accepts ISO 8601 timestamp or Unix seconds.

Examples:

"2025-09-05T00:00:00Z"

"1757030400"

resolution

enum<string>

required

Aggregation bucket size.

Available options:

1s,

1m,

5m,

10m,

15m,

1h,

6h,

1d

limit

integer

default:100

Maximum number of points to return in this page. Default: 100, max: 200.

Required range: x >= 1

Example:

100

cursor

string | null

Opaque cursor from a previous response metadata.next_cursor.

Response

Historical market-level metrics in the requested resolution.

Response body for GET /markets/{id_or_slug}/metrics.

market_id

string

Canonical market ID.

Example:

"618831"

resolution

string

Applied resolution.

Example:

"1h"

data

MetricDataPoint · object[]

Chronological time series points for the requested range.

Show child attributes

metadata

HistoryPageMetadata · object

Pagination metadata for this history page.

Show child attributes

⌘I

Get market metrics history

curl --request GET \
  --url https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics",
  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 := "https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics"

	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("https://api.polyorderbooks.com/v1/markets/{id_or_slug}/metrics")

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

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

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

{
  "data": [
    {
      "liquidity": 45678,
      "spread": 0.015,
      "t": "2025-09-05T10:00:00Z",
      "volume": 1200.5
    },
    {
      "liquidity": 47010,
      "spread": 0.012,
      "t": "2025-09-05T11:00:00Z",
      "volume": 980
    }
  ],
  "market_id": "618831",
  "metadata": {
    "count": 2,
    "limit": 100
  },
  "resolution": "1h"
}

Getting started

Discovery

Historical

Reference

Get market metrics history

Authorizations

Path Parameters

Query Parameters

Response