Instruments

Provides metadata for available options contracts on supported exchanges, including exchange names, contract symbols, and data types (Order Book Events, Ticker, Trades, etc.) with associated data coverage periods.

GET /options/exchanges/information

Instruments

cURL

curl --request GET \
  --url https://api.amberdata.com/markets/options/exchanges/information \
  --compressed \
  --header 'Accept-Encoding: <accept-encoding>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.amberdata.com/markets/options/exchanges/information"

headers = {
    "Accept-Encoding": "<accept-encoding>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Encoding': '<accept-encoding>', 'x-api-key': '<api-key>'}
};

fetch('https://api.amberdata.com/markets/options/exchanges/information', 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.amberdata.com/markets/options/exchanges/information",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Encoding: <accept-encoding>",
    "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.amberdata.com/markets/options/exchanges/information"

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

	req.Header.Add("Accept-Encoding", "<accept-encoding>")
	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))

}

HttpResponse<String> response = Unirest.get("https://api.amberdata.com/markets/options/exchanges/information")
  .header("Accept-Encoding", "<accept-encoding>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amberdata.com/markets/options/exchanges/information")

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

request = Net::HTTP::Get.new(url)
request["Accept-Encoding"] = '<accept-encoding>'
request["x-api-key"] = '<api-key>'

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

200

{
  "status": 200,
  "title": "OK",
  "description": "Successful request",
  "payload": {
    "metadata": {
      "next": "https://api.amberdata.com/markets/options/exchanges/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA",
      "api-version": "2023-09-30"
    },
    "data": [
      {
        "exchange": "bybit",
        "instrument": "BTC-16AUG24-50000-C",
        "openInterest": {
          "startDate": 1721895646123,
          "endDate": 1722297559023
        },
        "orderBookSnapshot": {
          "startDate": 1721895180679,
          "endDate": 1722370735780
        },
        "orderBookEvent": {
          "startDate": 1721899231080,
          "endDate": 1721946070781
        },
        "ticker": {
          "startDate": 1721895381123,
          "endDate": 1722370799223
        }
      }
    ]
  }
}

Authorizations

x-api-key · string · header · required

Headers

Accept-Encoding · string · default: gzip, deflate, br · required

api-version · string

Query Parameters

exchange · string · default: deribit

[Optional] Only return data for the given exchange(s) (comma separated)

instrument · string

Only return data for the given pair.

includeInactive · boolean

[Optional] If true, endpoint returns all instruments, including delisted ones. [Defaults] True | False*.

timeFormat · string

[Optional] Time format of the timestamps in the return payload. [Defaults] milliseconds | ms* | iso | iso8601 | hr | human_readable

size · integer<int32>

[Optional] The number of records per page (only available when includeInactive=true).

Response

200 - application/json

200

status · integer · default: 0

Example:

200

title · string

Example:

"OK"

description · string

Example:

"Successful request"

payload · object

Show child attributes