TickQuote logoTickQuoteDocs

Docs search

Search the current language documentation index.

Docs/Market Data·API

Market instruments

Return supported public market instruments.

Method
GET
Path
/api/v1/market/instruments
Auth
Bearer token

Overview

Returns the public market instruments currently available to your account. Call this endpoint before building ticker pickers, stream selectors, or timeframe controls.

Common use cases

  • - Build ticker dropdowns
  • - Check which streams each ticker supports
  • - Check available kline timeframes

Request URL

Send the request to the base API URL with your product API key in the Authorization bearer header.

GET/api/v1/market/instruments
HTTP request
GET https://api.tickquote.com/api/v1/market/instruments
Authorization: Bearer <tkp_api_key>
Parameter
Description
This endpoint does not require query parameters.

Try It Out

Edit query parameters and send a demo or authenticated request from this endpoint page.

GET/api/v1/market/instruments
Live sandbox

Use demo_key to try it without an account.

Response

// Response will appear here after sending a request

Response

A successful REST response uses code 0 and message success. Always check code before reading data.

response.json
Sample payload
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "ticker": "EURUSD",
        "display_name": "EURUSD",
        "asset_class": "forex",
        "base_currency": "EUR",
        "quote_currency": "USD",
        "streams": [
          "quote",
          "kline",
          "snapshot"
        ],
        "timeframes": [
          "M1",
          "M5",
          "M15",
          "M30",
          "H1",
          "H4",
          "D1",
          "W1",
          "MN1"
        ]
      },
      {
        "ticker": "XAUUSD",
        "display_name": "XAUUSD",
        "asset_class": "metals",
        "base_currency": "XAU",
        "quote_currency": "USD",
        "streams": [
          "quote",
          "kline",
          "snapshot"
        ],
        "timeframes": [
          "M1",
          "M5",
          "M15",
          "M30",
          "H1",
          "H4",
          "D1",
          "W1",
          "MN1"
        ]
      }
    ]
  }
}

Examples

The examples below use compact tickers and the Authorization bearer header.

curl
cURL
curl "https://api.tickquote.com/api/v1/market/instruments" \
  -H "Authorization: Bearer $TICKQUOTE_API_KEY"
request.js
JavaScript
const response = await fetch("https://api.tickquote.com/api/v1/market/instruments", {
  headers: {
    Authorization: `Bearer ${process.env.TICKQUOTE_API_KEY}`,
  },
})

const payload = await response.json()
if (payload.code !== 0) {
  throw new Error(payload.message)
}

console.log(payload.data)

Field reference

Field
Sample
Description
ticker
EURUSD
Public compact ticker, for example EURUSD.
display_name
EURUSD
Display label for UI use. It currently matches ticker.
asset_class
forex
Asset class, for example forex or metals.
base_currency
EUR
Base currency from the ticker.
quote_currency
USD
Quote currency from the ticker.
streams
quote,kline,snapshot
WebSocket streams available for this ticker.
timeframes
M1,M5,M15,M30,H1,H4,D1,W1,MN1
Kline timeframes available for this ticker.

Important notes

  • - display_name currently matches ticker.
  • - asset_class currently focuses on forex and metals.
  • - streams lists only the public quote, kline, and snapshot capabilities.