Skip to main content
GET
/
instrument
cURL
curl --request GET \
  --url https://gateway.architect.exchange/api/instrument
{
  "category": "fx",
  "funding_settlement_currency": "<string>",
  "initial_margin_pct": "<string>",
  "maintenance_margin_pct": "<string>",
  "minimum_order_size": "<string>",
  "multiplier": "<string>",
  "price_scale": 123,
  "quote_currency": "<string>",
  "symbol": "<string>",
  "tick_size": "<string>",
  "contract_mark_price": "<string>",
  "contract_size": "<string>",
  "description": "<string>",
  "funding_rate_cap_lower_pct": "<string>",
  "funding_rate_cap_upper_pct": "<string>",
  "funding_schedule": {
    "exceptions": [
      {
        "date": "2023-12-25",
        "times": [
          {
            "hours": 1,
            "minutes": 1,
            "seconds": 1
          }
        ],
        "reason": "<string>"
      }
    ],
    "times": [
      {
        "days_of_week": [
          1
        ],
        "time_of_day": {
          "hours": 1,
          "minutes": 1,
          "seconds": 1
        }
      }
    ],
    "timezone": "Europe/London"
  },
  "funding_schedule_calendar_description": "<string>",
  "funding_schedule_time_description": "<string>",
  "price_band_lower_deviation_pct": "<string>",
  "price_band_upper_deviation_pct": "<string>",
  "price_bands": "<string>",
  "price_quotation": "<string>",
  "trading_schedule": {
    "segments": [
      {
        "days_of_week": [
          1
        ],
        "duration_seconds": 1,
        "expire_all_orders": true,
        "hide_market_data": true,
        "state": "CLOSED_FROZEN",
        "time_of_day": {
          "hours": 1,
          "minutes": 1,
          "seconds": 1
        }
      }
    ]
  },
  "underlying_benchmark_price": "<string>"
}

Query Parameters

symbol
string
required

Response

Instrument details

category
enum<string>
required
Available options:
fx,
equities,
metals
funding_settlement_currency
string
required
initial_margin_pct
string
required
maintenance_margin_pct
string
required
minimum_order_size
string
required
multiplier
string
required
price_scale
integer<int64>
required
quote_currency
string
required
symbol
string
required
tick_size
string
required
contract_mark_price
string | null
contract_size
string | null
description
string | null
funding_rate_cap_lower_pct
string | null
funding_rate_cap_upper_pct
string | null
funding_schedule
object

Machine-readable funding rate schedule for perpetual contracts

funding_schedule_calendar_description
string | null
funding_schedule_time_description
string | null
price_band_lower_deviation_pct
string | null
price_band_upper_deviation_pct
string | null
price_bands
string | null
price_quotation
string | null
trading_schedule
object

Trading schedule for an instrument, containing multiple trading hour segments

underlying_benchmark_price
string | null