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.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AX - Architect Exchange Docs","colors":{"primary":"#7bc9ff","light":"#0099ff","dark":"#0099ff"},"logo":{"light":"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/logo/light.svg?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=4d22d6ccaea2329d7d235919f126dfc8","dark":"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/logo/dark.svg?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=090614f78e5518059377b7965773cad1"},"favicon":"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/favicon.png?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=1cfa6ede544a434eea76dca196669f4e","navbar":{"links":[{"href":"mailto:support@architect.co","label":"Support"}],"primary":{"type":"button","label":"AX Sandbox","href":"https://sandbox.architect.exchange"}},"footer":{"socials":{"x":"https://x.com/","github":"https://github.com/","linkedin":"https://linkedin.com/company"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"architectfinancialtechnologiesinc","hasAudioNarration":false,"actualSubdomain":"architectfinancialtechnologiesinc","customDomains":["docs.architect.exchange"],"gitSource":{"type":"github","owner":"architect-xyz","repo":"ax-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acd633f2df4f53e3cb12a5b","collectionId":"d1f8e1a7-2ae0-40b6-87c3-5f46df10c2de","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acd633f2df4f53e3cb12a5b"},"entitlements":{},"buildId":"6acd633f2df4f53e3cb12a5b","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":44},{"language":"default","tag":"Guides","count":25},{"language":"default","tag":"Marketdata","count":14},{"language":"default","tag":"Order entry and management","count":10},{"language":"default","tag":"Portfolio management","count":9},{"language":"default","tag":"Candles","count":6},{"language":"default","tag":"User management","count":6},{"language":"default","tag":"Funding \u0026 Settlement","count":5},{"language":"default","tag":"How to Get Started","count":5},{"language":"default","tag":"About Us","count":4}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/symbols-instruments/get-instrument","slug":"/api-reference/symbols-instruments/get-instrument","pageMetadata":{"title":"Get instrument","openapi":"openapi/api-gateway.json GET /instrument","description":null,"href":"/api-reference/symbols-instruments/get-instrument"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get instrument","openapi":"openapi/api-gateway.json GET /instrument","description":null,"href":"/api-reference/symbols-instruments/get-instrument"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["api-gateway"],"operationId":"get_instrument","parameters":["2f539cd6-dbb7-417b-a739-8054d1ec7cb6"],"responses":{"200":"95b2b224-7c32-4abd-bc16-58fec1a44e9e","404":"7703e2da-cffd-4457-a037-4743c9725dab"},"method":"get","type":"path","servers":["2daf5b66-2159-4ffe-8112-91a73625fa36"],"security":[],"path":"/instrument","baseUrlOptions":["https://gateway.architect.exchange/api"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2f539cd6-dbb7-417b-a739-8054d1ec7cb6":{"name":"symbol","in":"query","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"95b2b224-7c32-4abd-bc16-58fec1a44e9e":{"description":"Instrument details","content":{"application/json":{"schema":{"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","isRequired":true,"uniqueKey":"additional_product_specs","typeLabel":"object"},"category":{"type":"string","enum":["compute","crypto","energy","energy_etfs","equities","fx","metals","treasuries"],"isRequired":true,"uniqueKey":"category","typeLabel":"enum\u003cstring>"},"funding_settlement_currency":{"type":"string","description":"Currency the contract settles in: funding settlement for perpetuals,\nfinal settlement at expiry for dated contracts.","isRequired":true,"uniqueKey":"funding_settlement_currency","typeLabel":"string"},"initial_margin_pct":{"type":"string","isRequired":true,"uniqueKey":"initial_margin_pct","typeLabel":"string"},"maintenance_margin_pct":{"type":"string","isRequired":true,"uniqueKey":"maintenance_margin_pct","typeLabel":"string"},"minimum_order_size":{"type":"string","isRequired":true,"uniqueKey":"minimum_order_size","typeLabel":"string"},"multiplier":{"type":"string","isRequired":true,"uniqueKey":"multiplier","typeLabel":"string"},"price_scale":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"price_scale","typeLabel":"integer\u003cint64>"},"quote_currency":{"type":"string","isRequired":true,"uniqueKey":"quote_currency","typeLabel":"string"},"symbol":{"type":"string","isRequired":true,"uniqueKey":"symbol","typeLabel":"string"},"tick_size":{"type":"string","isRequired":true,"uniqueKey":"tick_size","typeLabel":"string"},"contract_mark_price":{"oneOf":[{"type":"string","uniqueKey":"contract_mark_price.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"contract_mark_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract_mark_price","typeLabel":"string | null"},"contract_size":{"oneOf":[{"type":"string","uniqueKey":"contract_size.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"contract_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract_size","typeLabel":"string | null"},"delisted_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the instrument was delisted. A delisted instrument can no longer\nbe traded but remains queryable for historical data. Omitted while\nlisted.","uniqueKey":"delisted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the instrument was delisted. A delisted instrument can no longer\nbe traded but remains queryable for historical data. Omitted while\nlisted.","uniqueKey":"delisted_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"delisted_at","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"estimated_funding_supported":{"type":"boolean","description":"Whether a live index feed is configured for this instrument, so an\nintraday funding-rate estimate can be produced. When `false`, the\nestimated-funding endpoint reports the symbol as unsupported and\nclients should not surface an estimate for it.","uniqueKey":"estimated_funding_supported","typeLabel":"boolean"},"expiration":{"oneOf":[{"type":"string","format":"date-time","description":"Absolute expiration time for dated contracts. `None` for perpetuals.\nPresence of a value is the discriminator between dated and perpetual contracts.","uniqueKey":"expiration.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Absolute expiration time for dated contracts. `None` for perpetuals.\nPresence of a value is the discriminator between dated and perpetual contracts.","uniqueKey":"expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiration","typeLabel":"string\u003cdate-time> | null"},"funding_rate_cap_lower_pct":{"oneOf":[{"type":"string","uniqueKey":"funding_rate_cap_lower_pct.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"funding_rate_cap_lower_pct.oneOf.1","typeLabel":"null"}],"uniqueKey":"funding_rate_cap_lower_pct","typeLabel":"string | null"},"funding_rate_cap_upper_pct":{"oneOf":[{"type":"string","uniqueKey":"funding_rate_cap_upper_pct.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"funding_rate_cap_upper_pct.oneOf.1","typeLabel":"null"}],"uniqueKey":"funding_rate_cap_upper_pct","typeLabel":"string | null"},"funding_schedule":{"oneOf":[{"type":"null","uniqueKey":"funding_schedule.oneOf.0","typeLabel":"null"},{"type":"object","description":"Machine-readable funding rate schedule for perpetual contracts","required":["timezone","times","exceptions"],"properties":{"exceptions":{"type":"array","items":{"type":"object","required":["date","times"],"properties":{"date":{"type":"string","format":"date","description":"The date this exception applies to","isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].date","typeLabel":"string\u003cdate>"},"times":{"type":"array","items":{"type":"object","description":"Time of day representation","required":["hours","minutes"],"properties":{"hours":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].times.items.[INDEX].hours","typeLabel":"integer\u003cint32>"},"minutes":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].times.items.[INDEX].minutes","typeLabel":"integer\u003cint32>"},"seconds":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].times.items.[INDEX].seconds","typeLabel":"integer\u003cint32>"}},"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].times.items.[INDEX]","typeLabel":"object"},"description":"Replacement times for this date","isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].times","typeLabel":"object[]"},"reason":{"oneOf":[{"type":"string","description":"Human-readable reason","uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable reason","uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX].reason","typeLabel":"string | null"}},"uniqueKey":"funding_schedule.oneOf.1.exceptions.items.[INDEX]","typeLabel":"object"},"description":"Dates with modified schedules (e.g., half-days, special times, or holidays).\n\nNote: Exception dates are interpreted in the schedule's timezone (the benchmark timezone),\nnot UTC. For example, if the timezone is \"America/New_York\" and an exception date is\n\"2025-12-25\", it refers to December 25th in New York time.","isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.exceptions","typeLabel":"object[]"},"times":{"type":"array","items":{"type":"object","required":["days_of_week","time_of_day"],"properties":{"days_of_week":{"type":"array","items":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"funding_schedule.oneOf.1.times.items.[INDEX].days_of_week.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"Days of week (1=Monday, 7=Sunday)","isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.times.items.[INDEX].days_of_week","typeLabel":"integer\u003cint32>[]"},"time_of_day":{"type":"object","description":"Funding time","required":["hours","minutes"],"properties":{"hours":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.times.items.[INDEX].time_of_day.hours","typeLabel":"integer\u003cint32>"},"minutes":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.times.items.[INDEX].time_of_day.minutes","typeLabel":"integer\u003cint32>"},"seconds":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"funding_schedule.oneOf.1.times.items.[INDEX].time_of_day.seconds","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.times.items.[INDEX].time_of_day","typeLabel":"object"}},"uniqueKey":"funding_schedule.oneOf.1.times.items.[INDEX]","typeLabel":"object"},"description":"Recurring funding times","isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.times","typeLabel":"object[]"},"timezone":{"type":"string","description":"Timezone for all times (chrono_tz::Tz, serializes as IANA string)","example":"Europe/London","isRequired":true,"uniqueKey":"funding_schedule.oneOf.1.timezone","typeLabel":"string"}},"uniqueKey":"funding_schedule.oneOf.1","typeLabel":"object"}],"uniqueKey":"funding_schedule","typeLabel":"null | object"},"funding_schedule_calendar_description":{"oneOf":[{"type":"string","uniqueKey":"funding_schedule_calendar_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"funding_schedule_calendar_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"funding_schedule_calendar_description","typeLabel":"string | null"},"funding_schedule_time_description":{"oneOf":[{"type":"string","uniqueKey":"funding_schedule_time_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"funding_schedule_time_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"funding_schedule_time_description","typeLabel":"string | null"},"is_closing":{"type":"boolean","description":"True while the instrument is closed to new orders and modifications\nahead of delisting; cancels are still accepted. Omitted when false.","uniqueKey":"is_closing","typeLabel":"boolean"},"price_band_lower_deviation_pct":{"oneOf":[{"type":"string","uniqueKey":"price_band_lower_deviation_pct.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"price_band_lower_deviation_pct.oneOf.1","typeLabel":"null"}],"uniqueKey":"price_band_lower_deviation_pct","typeLabel":"string | null"},"price_band_upper_deviation_pct":{"oneOf":[{"type":"string","uniqueKey":"price_band_upper_deviation_pct.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"price_band_upper_deviation_pct.oneOf.1","typeLabel":"null"}],"uniqueKey":"price_band_upper_deviation_pct","typeLabel":"string | null"},"price_bands":{"oneOf":[{"type":"string","uniqueKey":"price_bands.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"price_bands.oneOf.1","typeLabel":"null"}],"uniqueKey":"price_bands","typeLabel":"string | null"},"price_quotation":{"oneOf":[{"type":"string","uniqueKey":"price_quotation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"price_quotation.oneOf.1","typeLabel":"null"}],"uniqueKey":"price_quotation","typeLabel":"string | null"},"product":{"type":"string","description":"Umbrella product this instrument belongs to (e.g. `XAU` for `XAU-PERP`,\n`XAU-2026-SEP`, `XAU-2026-DEC`). Instruments that share a `product` are the\nsame underlying and can be grouped together in a product list.","uniqueKey":"product","typeLabel":"string"},"trading_schedule":{"oneOf":[{"type":"null","uniqueKey":"trading_schedule.oneOf.0","typeLabel":"null"},{"type":"object","description":"Trading schedule for an instrument, containing multiple trading hour segments","required":["segments"],"properties":{"segments":{"type":"array","items":{"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":{"type":"array","items":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].days_of_week.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"Days of the week (1=Monday, 2=Tuesday, ..., 7=Sunday)","isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].days_of_week","typeLabel":"integer\u003cint32>[]"},"duration_seconds":{"type":"integer","format":"int64","description":"Duration of this segment in seconds","minimum":0,"isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].duration_seconds","typeLabel":"integer\u003cint64>"},"expire_all_orders":{"type":"boolean","description":"Whether to expire all orders during this segment","isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].expire_all_orders","typeLabel":"boolean"},"hide_market_data":{"type":"boolean","description":"Whether to hide market data during this segment","isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].hide_market_data","typeLabel":"boolean"},"state":{"type":"string","enum":["CLOSED_FROZEN","PRE_OPEN","OPEN","CLOSED","DELISTED","HALTED","MATCH_AND_CLOSE_AUCTION","UNKNOWN"],"description":"Trading state during this segment","isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"time_of_day":{"type":"object","description":"Time of day when this segment starts","required":["hours","minutes"],"properties":{"hours":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].time_of_day.hours","typeLabel":"integer\u003cint32>"},"minutes":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].time_of_day.minutes","typeLabel":"integer\u003cint32>"},"seconds":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].time_of_day.seconds","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX].time_of_day","typeLabel":"object"}},"uniqueKey":"trading_schedule.oneOf.1.segments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"trading_schedule.oneOf.1.segments","typeLabel":"object[]"}},"uniqueKey":"trading_schedule.oneOf.1","typeLabel":"object"}],"uniqueKey":"trading_schedule","typeLabel":"null | object"},"underlying_benchmark_price":{"oneOf":[{"type":"string","uniqueKey":"underlying_benchmark_price.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"underlying_benchmark_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"underlying_benchmark_price","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"additional_product_specs":{},"category":"compute","funding_settlement_currency":"\u003cstring>","initial_margin_pct":"\u003cstring>","maintenance_margin_pct":"\u003cstring>","minimum_order_size":"\u003cstring>","multiplier":"\u003cstring>","price_scale":123,"quote_currency":"\u003cstring>","symbol":"\u003cstring>","tick_size":"\u003cstring>","contract_mark_price":"\u003cstring>","contract_size":"\u003cstring>","delisted_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","estimated_funding_supported":true,"expiration":"2023-11-07T05:31:56Z","funding_rate_cap_lower_pct":"\u003cstring>","funding_rate_cap_upper_pct":"\u003cstring>","funding_schedule":{"exceptions":[{"date":"2023-12-25","times":[{"hours":1,"minutes":1,"seconds":1}],"reason":"\u003cstring>"}],"times":[{"days_of_week":[1],"time_of_day":{"hours":1,"minutes":1,"seconds":1}}],"timezone":"Europe/London"},"funding_schedule_calendar_description":"\u003cstring>","funding_schedule_time_description":"\u003cstring>","is_closing":true,"price_band_lower_deviation_pct":"\u003cstring>","price_band_upper_deviation_pct":"\u003cstring>","price_bands":"\u003cstring>","price_quotation":"\u003cstring>","product":"\u003cstring>","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":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7703e2da-cffd-4457-a037-4743c9725dab":{"description":"Instrument not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"2daf5b66-2159-4ffe-8112-91a73625fa36":{"url":"https://gateway.architect.exchange/api"}}},"originalFileLocation":"openapi/api-gateway.json"},"subdomain":"architectfinancialtechnologiesinc","siteName":"AX - Architect Exchange Docs","title":"Get instrument - AX - Architect Exchange Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T21:25:34.844Z","originalFileLocation":"api-reference/symbols-instruments/get-instrument.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"AX - Architect Exchange Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get instrument - AX - Architect Exchange Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AX - Architect Exchange Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://architectfinancialtechnologiesinc.mintlify.app/_mintlify/api/og/v2?division=Symbols+and+instruments\u0026amp;title=Get+instrument\u0026amp;theme=b2862bb0f68d7e13aef94a0d\u0026amp;signature=331bfc9cda9b0c7067a506377637e1b3eae827a43f37b3bfb00f982237772a58\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get instrument - AX - Architect Exchange Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://architectfinancialtechnologiesinc.mintlify.app/_mintlify/api/og/v2?division=Symbols+and+instruments\u0026amp;title=Get+instrument\u0026amp;theme=b2862bb0f68d7e13aef94a0d\u0026amp;signature=331bfc9cda9b0c7067a506377637e1b3eae827a43f37b3bfb00f982237772a58\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AX - Architect Exchange Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7bc9ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/symbols-instruments/get-instrument.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.architect.exchange/#organization\",\"name\":\"AX - Architect Exchange Docs\",\"url\":\"https://docs.architect.exchange\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/logo/light.svg?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=4d22d6ccaea2329d7d235919f126dfc8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.architect.exchange#website\",\"name\":\"AX - Architect Exchange Docs\",\"url\":\"https://docs.architect.exchange\",\"publisher\":{\"@id\":\"https://docs.architect.exchange/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument#webpage\",\"url\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument\",\"name\":\"Get instrument\",\"dateModified\":\"2026-10-05T21:25:34.844Z\",\"isPartOf\":{\"@id\":\"https://docs.architect.exchange#website\"},\"breadcrumb\":{\"@id\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Symbols and instruments\",\"item\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instruments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get instrument\",\"item\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument#apireference\",\"headline\":\"Get instrument\",\"name\":\"Get instrument\",\"url\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument\",\"mainEntityOfPage\":{\"@id\":\"https://docs.architect.exchange/api-reference/symbols-instruments/get-instrument#webpage\"},\"dateModified\":\"2026-10-05T21:25:34.844Z\",\"publisher\":{\"@id\":\"https://docs.architect.exchange/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.architect.exchange#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AX - Architect Exchange Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AX - Architect Exchange Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"User management","pages":[{"title":"Get current user details","openapi":"openapi/api-gateway.json GET /whoami","href":"/api-reference/user-management/get-whoami"},{"title":"Logout","openapi":"openapi/api-gateway.json POST /logout","href":"/api-reference/user-management/logout"},{"title":"Get API keys","openapi":"openapi/api-gateway.json GET /api-keys","href":"/api-reference/user-management/get-api-keys"},{"title":"Create API key","openapi":"openapi/api-gateway.json POST /api-keys","href":"/api-reference/user-management/create-api-key"},{"title":"Revoke API key","openapi":"openapi/api-gateway.json DELETE /api-keys","href":"/api-reference/user-management/revoke-api-key"},{"title":"Get auth token","openapi":"openapi/api-gateway.json POST /authenticate","href":"/api-reference/user-management/authenticate"}]},{"group":"Liquidity program","pages":[{"title":"List liquidity programs","openapi":"openapi/api-gateway.json GET /mmlp/v2/programs","href":"/api-reference/liquidity-program/get-programs"},{"title":"Get reward accruals","openapi":"openapi/api-gateway.json GET /mmlp/v2/reward-accruals","href":"/api-reference/liquidity-program/get-reward-accruals"},{"title":"Get score snapshots","openapi":"openapi/api-gateway.json GET /mmlp/v2/{symbol}/score-snapshots","href":"/api-reference/liquidity-program/get-score-snapshots"}]},{"group":"Symbols and instruments","pages":[{"title":"Get instruments","openapi":"openapi/api-gateway.json GET /instruments","description":null,"href":"/api-reference/symbols-instruments/get-instruments"},{"title":"Get instrument","openapi":"openapi/api-gateway.json GET /instrument","href":"/api-reference/symbols-instruments/get-instrument"}]},{"group":"Marketdata","pages":[{"group":"Candles","pages":[{"group":"OHLC Candles","pages":[{"title":"Get candles","openapi":"openapi/api-gateway.json GET /candles","description":null,"href":"/api-reference/marketdata/get-candles"},{"title":"Get current candle","openapi":"openapi/api-gateway.json GET /candles/current","href":"/api-reference/marketdata/get-current-candle"},{"title":"Get last candle","openapi":"openapi/api-gateway.json GET /candles/last","href":"/api-reference/marketdata/get-last-candle"}]},{"group":"BBO Candles","pages":[{"title":"Get BBO candles","openapi":"openapi/api-gateway.json GET /bbo-candles","href":"/api-reference/marketdata/get-bbo-candles"},{"title":"Get current BBO candle","openapi":"openapi/api-gateway.json GET /bbo-candles/current","href":"/api-reference/marketdata/get-current-bbo-candle"},{"title":"Get last BBO candle","openapi":"openapi/api-gateway.json GET /bbo-candles/last","href":"/api-reference/marketdata/get-last-bbo-candle"}]}]},{"title":"Get tickers","openapi":"openapi/api-gateway.json GET /tickers","href":"/api-reference/marketdata/get-tickers"},{"title":"Get ticker","openapi":"openapi/api-gateway.json GET /ticker","href":"/api-reference/marketdata/get-ticker"},{"title":"Get trades","openapi":"openapi/api-gateway.json GET /trades","href":"/api-reference/marketdata/get-trades"},{"title":"Get orderbook","openapi":"openapi/api-gateway.json GET /book","href":"/api-reference/marketdata/get-book"},{"title":"Preview aggressive limit order","openapi":"openapi/api-gateway.json POST /preview-aggressive-limit-order","href":"/api-reference/marketdata/preview-aggressive-limit-order"},{"title":"Get funding rates","openapi":"openapi/api-gateway.json GET /funding-rates","href":"/api-reference/marketdata/get-funding-rates"},{"title":"Get upcoming special settlements","openapi":"openapi/api-gateway.json GET /special-settlements-pending","href":"/api-reference/marketdata/get-upcoming-special-settlements"},{"title":"Websocket marketdata","asyncapi":"openapi/asyncapi-marketdata-publisher.bundled.json marketdata","href":"/api-reference/marketdata/md-ws"}]},{"group":"Portfolio management","pages":[{"title":"Get balances","openapi":"openapi/api-gateway.json GET /balances","href":"/api-reference/portfolio-management/get-balances"},{"title":"Get fills","openapi":"openapi/api-gateway.json GET /fills","href":"/api-reference/portfolio-management/get-fills"},{"title":"Get liquidations","openapi":"openapi/api-gateway.json GET /liquidations","href":"/api-reference/portfolio-management/get-liquidations"},{"title":"Get positions","openapi":"openapi/api-gateway.json GET /positions","href":"/api-reference/portfolio-management/get-positions"},{"title":"Get risk snapshot","openapi":"openapi/api-gateway.json GET /risk-snapshot","href":"/api-reference/portfolio-management/get-risk-snapshot"},{"title":"Get transactions","openapi":"openapi/api-gateway.json GET /transactions","href":"/api-reference/portfolio-management/get-transactions"},{"title":"Get funding transactions","openapi":"openapi/api-gateway.json GET /funding-transactions","href":"/api-reference/portfolio-management/get-funding-transactions"},{"title":"Sandbox deposit","openapi":"openapi/api-gateway.json POST /sandbox/deposit","href":"/api-reference/portfolio-management/sandbox-deposit"},{"title":"Sandbox withdrawal","openapi":"openapi/api-gateway.json POST /sandbox/withdraw","href":"/api-reference/portfolio-management/sandbox-withdrawal"}]},{"group":"Order entry and management","pages":[{"title":"Get open orders","openapi":"openapi/order-gateway.json GET /open-orders","href":"/api-reference/order-management/get-open-orders"},{"title":"Get historical orders","openapi":"openapi/order-gateway.json GET /orders","href":"/api-reference/order-management/get-orders"},{"title":"Place order","openapi":"openapi/order-gateway.json POST /place-order","href":"/api-reference/order-management/place-order"},{"title":"Cancel order","openapi":"openapi/order-gateway.json POST /cancel-order","href":"/api-reference/order-management/cancel-order"},{"title":"Cancel all orders","openapi":"openapi/order-gateway.json POST /cancel-all-orders","href":"/api-reference/order-management/cancel-all-orders"},{"title":"Replace order","openapi":"openapi/order-gateway.json POST /replace-order","href":"/api-reference/order-management/replace-order"},{"title":"Search order status","openapi":"openapi/order-gateway.json GET /order-status","href":"/api-reference/order-management/get-order-status"},{"title":"See order fills","openapi":"openapi/order-gateway.json GET /order-fills","href":"/api-reference/order-management/get-order-fills"},{"title":"Calculate initial margin requirement","openapi":"openapi/order-gateway.json POST /initial-margin-requirement","href":"/api-reference/order-management/calculate-initial-margin-requirement"},{"title":"Websocket orders","asyncapi":"openapi/asyncapi-order-gateway.bundled.json orders","href":"/api-reference/order-management/orders-ws"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Get instrument - AX - Architect Exchange Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}