{ "openapi": "3.0.1", "info": { "title": "Financial Instrument Database & Symbol Search", "description": "Search 300,000+ stocks, ETFs, funds, indices, currencies, cryptocurrencies, and money markets by ticker, exchange, country, sector, category, or identifier.", "version": "0.1", "x-build-id": "LXacbBxWlBRskhUcy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchfinch~global-financial-instrument-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchfinch-global-financial-instrument-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/fetchfinch~global-financial-instrument-finder/runs": { "post": { "operationId": "runs-sync-fetchfinch-global-financial-instrument-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/fetchfinch~global-financial-instrument-finder/run-sync": { "post": { "operationId": "run-sync-fetchfinch-global-financial-instrument-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "operation": { "title": "Operation", "enum": [ "search", "lookup", "facets" ], "type": "string", "description": "Search returns matching records, lookup supports exact symbol/identifier matching, and facets returns available values with counts.", "default": "search" }, "assetTypes": { "title": "Asset types", "type": "array", "description": "Leave empty to search every asset class.", "items": { "type": "string", "enum": [ "equities", "etfs", "funds", "indices", "currencies", "cryptos", "moneymarkets" ], "enumTitles": [ "Equities", "ETFs", "Funds", "Indices", "Currencies", "Cryptocurrencies", "Money markets" ] } }, "query": { "title": "Search query", "type": "string", "description": "Keyword search across symbols, names, summaries, websites, and security identifiers. Example: renewable energy." }, "queryMode": { "title": "Query matching", "enum": [ "keywords", "substring" ], "type": "string", "description": "Substring matching is useful for partial identifiers but can be slower on large searches.", "default": "keywords" }, "symbols": { "title": "Exact symbols", "type": "array", "description": "Exact symbol filter, such as AAPL, MSFT, or AAPL.US.", "items": { "type": "string" } }, "lookupValues": { "title": "Identifiers to lookup", "type": "array", "description": "Exact values matched against symbol, ISIN, CUSIP, FIGI, composite FIGI, and share-class FIGI.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Headquarters country for equities, or the relevant country classification where available.", "items": { "type": "string" } }, "currencies": { "title": "Currencies", "type": "array", "description": "Instrument or quote currency, such as USD or EUR.", "items": { "type": "string" } }, "sectors": { "title": "Sectors", "type": "array", "description": "Equity sectors.", "items": { "type": "string" } }, "industryGroups": { "title": "Industry groups", "type": "array", "description": "Equity industry groups.", "items": { "type": "string" } }, "industries": { "title": "Industries", "type": "array", "description": "Equity industries.", "items": { "type": "string" } }, "exchanges": { "title": "Exchanges", "type": "array", "description": "Exchange codes such as NYQ, NMS, or AMS.", "items": { "type": "string" } }, "mics": { "title": "MIC codes", "type": "array", "description": "ISO 10383 market identifier codes.", "items": { "type": "string" } }, "markets": { "title": "Markets", "type": "array", "description": "Human-readable market names.", "items": { "type": "string" } }, "marketCaps": { "title": "Market-cap classes", "type": "array", "description": "Equity classes such as Large Cap or Micro Cap.", "items": { "type": "string" } }, "categoryGroups": { "title": "Category groups", "type": "array", "description": "ETF, fund, or index category groups.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "ETF, fund, or index categories.", "items": { "type": "string" } }, "families": { "title": "Families", "type": "array", "description": "ETF, fund, or money-market families.", "items": { "type": "string" } }, "baseCurrencies": { "title": "Base currencies", "type": "array", "description": "Base currencies for currency pairs.", "items": { "type": "string" } }, "quoteCurrencies": { "title": "Quote currencies", "type": "array", "description": "Quote currencies for currency pairs.", "items": { "type": "string" } }, "cryptocurrencies": { "title": "Cryptocurrencies", "type": "array", "description": "Underlying cryptocurrency symbols such as BTC or ETH.", "items": { "type": "string" } }, "primaryListingsOnly": { "title": "Primary listings only", "type": "boolean", "description": "Exclude dotted symbols for equities, ETFs, and funds. This follows the upstream package heuristic and is not an exchange-authoritative listing flag.", "default": false }, "includeDelisted": { "title": "Include delisted equities", "type": "boolean", "description": "Include records marked delisted by the source.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "name", "symbol", "assetType" ], "type": "string", "description": "Sort returned records by human-readable name, symbol, or asset type.", "default": "name" }, "sortDirection": { "title": "Sort direction", "enum": [ "ascending", "descending" ], "type": "string", "description": "Sort records in ascending or descending order.", "default": "ascending" }, "limit": { "title": "Maximum records", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Defaults to 100. Use 0 only with allowLargeExport enabled.", "default": 100 }, "offset": { "title": "Offset", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Number of matching records to skip before writing results.", "default": 0 }, "allowLargeExport": { "title": "Allow large export", "type": "boolean", "description": "Required for limit=0 or more than 10,000 records. Large exports can create substantial Apify dataset usage.", "default": false }, "facetLimit": { "title": "Facet values per field", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Used only by the facets operation.", "default": 100 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }