{"openapi":"3.1.0","info":{"title":"OpenFIGI (BYOK) API","version":"0.1.0","description":"OpenFIGI (BYOK) lets an AI assistant read your own OpenFIGI data through the OpenFIGI API with a key you supply (OpenFIGI API key). Read-only: 6 tools (search_instruments, filter_instruments, list_id_types, list_exchange_codes, list_security_types, list_market_sectors). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-openfigi.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-openfigi/docs"},"termsOfService":"https://connectorbay.com/byok-openfigi/terms"},"servers":[{"url":"https://byok-openfigi.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-openfigi/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/search_instruments":{"post":{"operationId":"search_instruments","summary":"Search FIGI records by keywords (for example a company name or ticker) with optional exchange, currency and sector filte","description":"Search FIGI records by keywords (for example a company name or ticker) with optional exchange, currency and sector filters. Pages through results with the next token. Use for \"Search FIGIs for instruments matching 'ibm' on the US exchange\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Keywords to search for, for example 'ibm' or a company name.","maxLength":200,"title":"Query","type":"string"},"start":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The next token from the previous answer, to fetch the following page.","title":"Start"},"exch_code":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Exchange code filter, for example 'US' (list_enum_values with key exchCode shows all). Not together with mic_code.","title":"Exch Code"},"mic_code":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"ISO market identification code filter, for example 'XNYS'. Not together with exch_code.","title":"Mic Code"},"currency":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Currency filter, for example 'USD'.","title":"Currency"},"market_sector":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Market sector filter, for example 'Equity', 'Corp', 'Govt', 'Comdty', 'Curncy', 'Index', 'Muni', 'Mtge', 'Pfd'.","title":"Market Sector"},"security_type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Security type filter, for example 'Common Stock'.","title":"Security Type"},"security_type2":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Alternative, less specific security type filter, for example 'Option'.","title":"Security Type2"},"include_unlisted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to include unlisted and delisted equities (excluded by default).","title":"Include Unlisted"}},"required":["query"],"title":"search_instrumentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/filter_instruments":{"post":{"operationId":"filter_instruments","summary":"List FIGI records that match the filters (exchange, currency, sector, security type), alphabetically by FIGI, with an op","description":"List FIGI records that match the filters (exchange, currency, sector, security type), alphabetically by FIGI, with an optional keyword. Pages with the next token. Use for \"List FIGI records for US exchange equities\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Optional keywords to narrow the filter.","title":"Query"},"start":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The next token from the previous answer, to fetch the following page.","title":"Start"},"exch_code":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Exchange code filter, for example 'US' (list_enum_values with key exchCode shows all). Not together with mic_code.","title":"Exch Code"},"mic_code":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"ISO market identification code filter, for example 'XNYS'. Not together with exch_code.","title":"Mic Code"},"currency":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Currency filter, for example 'USD'.","title":"Currency"},"market_sector":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Market sector filter, for example 'Equity', 'Corp', 'Govt', 'Comdty', 'Curncy', 'Index', 'Muni', 'Mtge', 'Pfd'.","title":"Market Sector"},"security_type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Security type filter, for example 'Common Stock'.","title":"Security Type"},"security_type2":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Alternative, less specific security type filter, for example 'Option'.","title":"Security Type2"},"include_unlisted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to include unlisted and delisted equities (excluded by default).","title":"Include Unlisted"}},"title":"filter_instrumentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_id_types":{"post":{"operationId":"list_id_types","summary":"List the identifier types OpenFIGI accepts for third-party codes (ticker, ISIN, CUSIP, SEDOL and others). Use for \"Which","description":"List the identifier types OpenFIGI accepts for third-party codes (ticker, ISIN, CUSIP, SEDOL and others). Use for \"Which identifier types does OpenFIGI know\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_id_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_exchange_codes":{"post":{"operationId":"list_exchange_codes","summary":"List the exchange codes usable in the exchange filter of searches. Use for \"Which exchange codes can I filter FIGI searc","description":"List the exchange codes usable in the exchange filter of searches. Use for \"Which exchange codes can I filter FIGI searches by\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_exchange_codesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_security_types":{"post":{"operationId":"list_security_types","summary":"List the security types usable in the security type filter of searches. Use for \"Which security types does OpenFIGI use\"","description":"List the security types usable in the security type filter of searches. Use for \"Which security types does OpenFIGI use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_security_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_market_sectors":{"post":{"operationId":"list_market_sectors","summary":"List the market sector descriptions (Equity, Corp, Govt, Comdty and so on) usable in the sector filter of searches. Use ","description":"List the market sector descriptions (Equity, Corp, Govt, Comdty and so on) usable in the sector filter of searches. Use for \"Which market sectors does OpenFIGI define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_market_sectorsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}