> ## Documentation Index > Fetch the complete documentation index at: https://docs.architect.exchange/llms.txt > Use this file to discover all available pages before exploring further. # Get instrument ## OpenAPI ````yaml openapi/api-gateway.json GET /instrument openapi: 3.1.0 info: title: ax-api-gateway description: '' license: name: '' version: 15.22.0 servers: - url: https://gateway.architect.exchange/api security: [] tags: - name: api-gateway description: API gateway paths: /instrument: get: tags: - api-gateway operationId: get_instrument parameters: - name: symbol in: query required: true schema: type: string responses: '200': description: Instrument details content: application/json: schema: $ref: '#/components/schemas/GetInstrumentResponse' '404': description: Instrument not found components: schemas: GetInstrumentResponse: $ref: '#/components/schemas/Instrument' Instrument: type: object required: - symbol - multiplier - price_scale - minimum_order_size - tick_size - quote_currency - funding_settlement_currency - maintenance_margin_pct - initial_margin_pct - category - additional_product_specs properties: additional_product_specs: type: object category: $ref: '#/components/schemas/InstrumentCategory' contract_mark_price: type: - string - 'null' contract_size: type: - string - 'null' description: type: - string - 'null' estimated_funding_supported: type: boolean description: |- Whether a live index feed is configured for this instrument, so an intraday funding-rate estimate can be produced. When `false`, the estimated-funding endpoint reports the symbol as unsupported and clients should not surface an estimate for it. expiration: type: - string - 'null' format: date-time description: >- Absolute expiration time for dated contracts. `None` for perpetuals. Presence of a value is the discriminator between dated and perpetual contracts. funding_rate_cap_lower_pct: type: - string - 'null' funding_rate_cap_upper_pct: type: - string - 'null' funding_schedule: oneOf: - type: 'null' - $ref: '#/components/schemas/FundingRateSchedule' funding_schedule_calendar_description: type: - string - 'null' funding_schedule_time_description: type: - string - 'null' funding_settlement_currency: type: string initial_margin_pct: type: string maintenance_margin_pct: type: string minimum_order_size: type: string multiplier: type: string price_band_lower_deviation_pct: type: - string - 'null' price_band_upper_deviation_pct: type: - string - 'null' price_bands: type: - string - 'null' price_quotation: type: - string - 'null' price_scale: type: integer format: int64 product: type: string description: >- Umbrella product this instrument belongs to (e.g. `XAU` for `XAU-PERP`, `XAU-2026-SEP`, `XAU-2026-DEC`). Instruments that share a `product` are the same underlying and can be grouped together in a product list. quote_currency: type: string symbol: type: string tick_size: type: string trading_schedule: oneOf: - type: 'null' - $ref: '#/components/schemas/TradingSchedule' underlying_benchmark_price: type: - string - 'null' InstrumentCategory: type: string enum: - compute - crypto - energy - energy_etfs - equities - fx - metals - treasuries FundingRateSchedule: type: object description: Machine-readable funding rate schedule for perpetual contracts required: - timezone - times - exceptions properties: exceptions: type: array items: $ref: '#/components/schemas/FundingException' description: >- Dates with modified schedules (e.g., half-days, special times, or holidays). Note: Exception dates are interpreted in the schedule's timezone (the benchmark timezone), not UTC. For example, if the timezone is "America/New_York" and an exception date is "2025-12-25", it refers to December 25th in New York time. times: type: array items: $ref: '#/components/schemas/FundingTime' description: Recurring funding times timezone: type: string description: Timezone for all times (chrono_tz::Tz, serializes as IANA string) example: Europe/London TradingSchedule: type: object description: >- Trading schedule for an instrument, containing multiple trading hour segments required: - segments properties: segments: type: array items: $ref: '#/components/schemas/TradingHoursSegment' FundingException: type: object required: - date - times properties: date: type: string format: date description: The date this exception applies to reason: type: - string - 'null' description: Human-readable reason times: type: array items: $ref: '#/components/schemas/TimeOfDay' description: Replacement times for this date FundingTime: type: object required: - days_of_week - time_of_day properties: days_of_week: $ref: '#/components/schemas/DaysOfWeek' description: Days of week (1=Monday, 7=Sunday) time_of_day: $ref: '#/components/schemas/TimeOfDay' description: Funding time TradingHoursSegment: type: object description: A single trading hours segment with specific days, times, and state required: - days_of_week - time_of_day - duration_seconds - state - hide_market_data - expire_all_orders properties: days_of_week: $ref: '#/components/schemas/DaysOfWeek' description: Days of the week (1=Monday, 2=Tuesday, ..., 7=Sunday) duration_seconds: type: integer format: int64 description: Duration of this segment in seconds minimum: 0 expire_all_orders: type: boolean description: Whether to expire all orders during this segment hide_market_data: type: boolean description: Whether to hide market data during this segment state: $ref: '#/components/schemas/InstrumentState' description: Trading state during this segment time_of_day: $ref: '#/components/schemas/TimeOfDay' description: Time of day when this segment starts TimeOfDay: type: object description: Time of day representation required: - hours - minutes properties: hours: type: integer format: int32 minimum: 0 minutes: type: integer format: int32 minimum: 0 seconds: type: integer format: int32 minimum: 0 DaysOfWeek: type: array items: type: integer format: int32 minimum: 0 description: |- Days of week using ISO 8601 numbering (1=Monday, 7=Sunday). This type ensures that all day values are in the valid range [1, 7]. It is serialized as a JSON array of numbers for API compatibility. InstrumentState: type: string enum: - CLOSED_FROZEN - PRE_OPEN - OPEN - CLOSED - DELISTED - HALTED - MATCH_AND_CLOSE_AUCTION - UNKNOWN ````