{ "openapi": "3.0.3", "info": { "title": "Bigdata Knowledge Graph API", "version": "1.0.0", "description": "Access structured data from the Knowledge Graph to find companies, people, places, and other entities with detailed information." }, "servers": [ { "url": "https://api.bigdata.com/", "description": "Production server" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } }, "schemas": { "FindCompaniesRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "It accepts a partial or complete company name, webpage, ticker, ISIN, SEDOL, or CUSIP. Examples: 'Apple', 'AAPL', 'https://www.apple.com/', 'CA03785Y1007'", "example": "Apple" }, "types": { "type": "array", "items": { "type": "string", "enum": ["PUBLIC", "PRIVATE"] }, "description": "The company type can be PUBLIC or PRIVATE", "example": ["PUBLIC"] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "description": "It accepts country codes using the ISO 3166-1 A-2, for instance \"US\" for the United States", "example": ["US", "FR"] }, "sectors": { "type": "array", "items": { "type": "string" }, "description": "It accepts a list of sectors that can be retrieved with the endpoint \"/knowledge-graph/companies/sectors\"", "example": ["Technology", "Financials", "Industrials"] } }, "description": "Request body for finding companies. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/companies/values/{filter}`.", "example": { "query": "Apple", "types": ["PUBLIC"], "countries": ["US", "FR"], "sectors": ["Technology", "Financials", "Industrials"] } }, "Company": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique company identifier in the Knowledge Graph", "example": "D8442A" }, "name": { "type": "string", "description": "Company name", "example": "Apple Inc." }, "description": { "type": "string", "description": "Company description and business overview", "example": "Apple Inc. (formerly Apple Computer Inc.), incorporated on January 03, 1977, designs, manufactures, and markets mobile communication and media devices, personal computing products, and portable digital music players worldwide." }, "type": { "type": "string", "enum": ["PUBLIC", "PRIVATE"], "description": "Company type classification", "example": "PUBLIC" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code (ISO 3166-1 alpha-2)", "example": "US" }, "sector": { "type": "string", "description": "Business sector", "example": "Technology" }, "industry_group": { "type": "string", "description": "Industry group classification", "example": "Computer Hardware" }, "industry": { "type": "string", "description": "Specific industry classification", "example": "Computer Hardware" }, "favicon": { "type": "string", "format": "uri", "description": "Company favicon URL", "example": "http://www.apple.com/favicon.ico" }, "webpage": { "type": "string", "format": "uri", "description": "Company website URL", "example": "http://www.apple.com" }, "isin_values": { "type": "array", "items": { "type": "string" }, "description": "International Securities Identification Numbers", "example": ["CA03785Y1007", "TH0150120408", "TH0809121500", "US0378331005"] }, "cusip_values": { "type": "array", "items": { "type": "string" }, "description": "Committee on Uniform Securities Identification Procedures numbers", "example": ["037833100", "03785Y100", "P0R684385", "Y100G4352", "Y49876132"] }, "sedol_values": { "type": "array", "items": { "type": "string" }, "description": "Stock Exchange Daily Official List numbers", "example": ["2046251", "BNC31R1", "BPXWT99", "BVBDDG1"] }, "listing_values": { "type": "array", "items": { "type": "string" }, "description": "Exchange listing identifiers", "example": ["XBKK:AAPL80", "XNAS:AAPL"] }, "ticker": { "type": "string", "description": "Primary ticker symbol", "example": "AAPL" } }, "required": ["id", "name", "type", "country"], "description": "Company entity with detailed information" }, "FindCompaniesResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Company" }, "description": "Array of company results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "4563eda4-3655-4bdf-8a83-82407ad25276" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2025-10-16T17:30:26.648779+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing company results and metadata" }, "ErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Error message" }, "code": { "type": "string", "description": "Error code" }, "details": { "type": "string", "description": "Additional error details" } }, "required": ["error"] }, "ValidationError": { "type": "object", "properties": { "detail": { "type": "array", "items": { "type": "object", "properties": { "loc": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "msg": { "type": "string" }, "type": { "type": "string" } }, "required": ["loc", "msg", "type"] } } }, "required": ["detail"] }, "Usage": { "type": "object", "properties": { "knowledge_graph_tokens": { "type": "integer", "description": "Number of tokens consumed by this request.", "example": 1 } }, "required": ["knowledge_graph_tokens"] }, "FindSourcesRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for sources by name or description. (e.g.,'MT Newswire', 'Benzinga', 'Bloomberg')", "example": "MT Newswire" }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "description": "Country codes using the ISO 3166-1 A-2 format (e.g., 'US' for United States, 'FR' for France, 'GB' for Great Britain)", "example": ["US", "FR", "GB"] }, "ranks": { "type": "array", "items": { "type": "string", "enum": ["RANK_1", "RANK_2", "RANK_3", "RANK_4", "RANK_5"] }, "description": "Source ranking from 1 to 5, where RANK_1 is the highest quality", "example": ["RANK_1", "RANK_2", "RANK_3"] }, "languages": { "type": "array", "items": { "type": "string" }, "description": "Filter sources by the language of their content, as published in the `language` field of results. Values are language names rather than ISO codes (e.g., 'English', not 'en')", "example": ["English"] }, "categories": { "type": "array", "items": { "type": "string", "enum": ["transcripts", "research", "podcasts", "news", "filings", "expert_interviews"] }, "description": "Available source categories", "example": ["transcripts", "research", "podcasts", "news", "filings", "expert_interviews"] }, "packages": { "type": "array", "items": { "type": "string", "enum": [ "alliance_news", "benzinga", "crypto_markets", "expert_networks", "financial_newswires", "fly_on_the_wall", "fxstreet", "middle_eastern_markets", "midnight_trader", "quartr_presentation_materials", "quartr_reports", "quartr_transcripts", "rp_factset_earnings_comparision", "rp_multi_source_earnings_comparision", "sec_filings", "public" ] }, "description": "Filter sources by available data packages", "example": ["sec_filings"] }, "tiers": { "type": "array", "items": { "type": "string" }, "description": "Filter sources by content tier, as published in the `tiers` field of results (e.g., 'web', 'premium-news')", "example": ["premium-news"] } }, "description": "Request body for finding sources. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/sources/values/{filter}`, except `packages`, `categories` and `tiers`, which cannot be enumerated.", "example": { "query": "MT Newswire", "countries": ["US", "FR", "GB"], "ranks": ["RANK_1", "RANK_2", "RANK_3"], "categories": ["transcripts", "research", "podcasts", "news", "filings", "expert_interviews"], "packages": ["sec_filings"] } }, "Source": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique source identifier in the Knowledge Graph", "example": "97C483" }, "name": { "type": "string", "description": "Source name", "example": "Personal Finance with Warren Ingram" }, "description": { "type": "string", "description": "Source description and overview", "example": "Personal Finance with Warren Ingram is a program that provides practical advice on money management, including guidance on investing, retirement planning, and wealth creation, through its podcast." }, "language": { "type": "string", "description": "Language of the source's content", "example": "English" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code (ISO 3166-1 alpha-2)", "example": "ZA" }, "rank": { "type": "string", "enum": ["RANK_1", "RANK_2", "RANK_3", "RANK_4", "RANK_5"], "description": "Source ranking from 1 to 5", "example": "RANK_1" }, "retention": { "type": "string", "description": "Data retention policy for the source", "example": "FULL_HISTORY" }, "favicon": { "type": "string", "format": "uri", "description": "Source favicon URL", "example": "https://www.podchaser.com/favicon.ico" }, "webpage": { "type": "string", "description": "Source webpage or platform", "example": "TV and Radio Transcripts" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Source categories", "example": ["podcasts"] }, "packages": { "type": "array", "items": { "type": "string" }, "description": "Available data packages for this source", "example": ["podcasts", "all"] }, "tiers": { "type": "array", "items": { "type": "string" }, "description": "Content tiers this source belongs to", "example": ["podcasts"] }, "subscribed": { "type": "boolean", "description": "Whether the user is subscribed to this source", "example": true } }, "required": ["id", "name", "country", "rank"], "description": "Source entity with detailed information" }, "FindSourcesResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Source" }, "description": "Array of source results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "user_2k3Z4SerTUIieyCfQhGR5UF2Af3" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2025-09-30T07:23:05.019121+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing source results and metadata" }, "FindETFsRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for ETFs by name, ticker, or description. Examples: 'Gold', 'SPDR', 'Vanguard'", "example": "Gold" }, "statuses": { "type": "array", "items": { "type": "string" }, "description": "Filter ETFs by listing status, as published in the `status` field of results (e.g., 'Active')", "example": ["Active"] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "description": "Country codes using the ISO 3166-1 A-2 format (e.g., 'US' for United States, 'FR' for France, 'GB' for Great Britain)", "example": ["US"] }, "sectors": { "type": "array", "items": { "type": "string" }, "description": "Sector classification, as published in the `sector` field of results. It accepts the same list of sectors as companies, which can be retrieved with the endpoint \"/knowledge-graph/companies/sectors\"", "example": ["Financials"] } }, "description": "Request body for finding ETFs. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/etfs/values/{filter}`.", "example": { "query": "Gold", "countries": ["US"] } }, "ETF": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ETF identifier in the Knowledge Graph", "example": "36CEB2" }, "name": { "type": "string", "description": "ETF name", "example": "Grayscale Bitcoin Trust ETF" }, "description": { "type": "string", "description": "ETF description and overview", "example": "Grayscale Bitcoin Trust ETF, formerly Grayscale Bitcoin Trust (BTC), is an open-ended trust that is invested exclusively in bitcoin. The trust was founded on September 13, 2013." }, "status": { "type": "string", "description": "ETF listing status", "example": "Active" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code (ISO 3166-1 alpha-2)", "example": "US" }, "sector": { "type": "string", "description": "ETF sector classification", "example": "Financials" }, "industry_group": { "type": "string", "description": "Industry group classification", "example": "Nonequity Investment Instruments" }, "industry": { "type": "string", "description": "Specific industry classification", "example": "Nonequity Investment Instruments" }, "webpage": { "type": "string", "format": "uri", "description": "ETF website URL", "example": "http://grayscale.com/products/grayscale-bitcoin-trust/" }, "favicon": { "type": "string", "format": "uri", "description": "ETF favicon URL", "example": "https://www.globalxetfs.com.au/favicon.ico" }, "isin_values": { "type": "array", "items": { "type": "string" }, "description": "International Securities Identification Numbers", "example": ["US3896371099"] }, "cusip_values": { "type": "array", "items": { "type": "string" }, "description": "Committee on Uniform Securities Identification Procedures numbers", "example": ["389637109"] }, "sedol_values": { "type": "array", "items": { "type": "string" }, "description": "Stock Exchange Daily Official List numbers", "example": ["6605528"] }, "listing_values": { "type": "array", "items": { "type": "string" }, "description": "Exchange listing identifiers", "example": ["OTCM:GBTC"] }, "ticker": { "type": "string", "description": "Primary ticker symbol", "example": "GBTC" } }, "required": ["id", "name", "country", "ticker"], "description": "ETF entity with detailed information" }, "FindETFsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ETF" }, "description": "Array of ETF results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "2a25111e-0043-4fe2-946e-668aa5af928a" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2026-07-02T13:24:45.163695+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing ETF results and metadata" }, "ISINRequest": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "Array of ISIN codes (up to 1000)", "example": ["US0378331005"] } }, "required": ["values"], "description": "Request body for ISIN lookups" }, "CUSIPRequest": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "Array of CUSIP codes (up to 1000)", "example": ["037833100"] } }, "required": ["values"], "description": "Request body for CUSIP lookups" }, "SEDOLRequest": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "Array of SEDOL codes (up to 1000)", "example": ["2046251"] } }, "required": ["values"], "description": "Request body for SEDOL lookups" }, "ListingRequest": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "Array of listing codes (up to 1000). Listing format: Combination of Market Identifier Code (MIC) and company ticker separated by \":\"", "example": ["XNAS:AAPL"] } }, "required": ["values"], "description": "Request body for listing lookups" }, "MarketIdResponse": { "type": "object", "properties": { "results": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Company" }, "description": "Object containing market identifiers as keys and company data as values", "example": { "US0378331005": { "id": "D8442A", "name": "Apple Inc.", "description": "Apple Inc. (formerly Apple Computer Inc.), incorporated on January 03, 1977, designs, manufactures, and markets mobile communication and media devices, personal computing products, and portable digital music players worldwide.", "type": "PUBLIC", "country": "US", "sector": "Technology", "industry_group": "Computer Hardware", "industry": "Computer Hardware", "favicon": "http://www.apple.com/favicon.ico", "webpage": "http://www.apple.com", "isin_values": ["CA03785Y1007", "TH0150120408", "TH0809121500", "US0378331005"], "cusip_values": ["037833100", "03785Y100", "P0R684385", "Y100G4352", "Y49876132"], "sedol_values": ["2046251", "BNC31R1", "BPXWT99", "BVBDDG1"], "listing_values": ["XBKK:AAPL80", "XNAS:AAPL"] } } }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "user_2nHybch9ZH2eWyGykznCeRxsk4G" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2025-09-30T12:03:24.732779+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing company data mapped by market identifiers" }, "FilterValuesResponse": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Every value the filter accepts, sorted", "example": ["Africa", "Antarctica", "Asia", "Europe", "North America", "Oceania", "South America"] }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "18f8fbd1-fa1d-4c67-9dd5-a2434ce1a6b5" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2025-10-08T06:35:46.901505+00:00" } }, "required": ["request_id", "timestamp"] } }, "required": ["values"] }, "SectorsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "string" }, "description": "Array of available sectors for filtering companies", "example": ["Technology", "Financials", "Consumer Services", "Health Care", "Consumer Goods", "Industrials", "Basic Materials", "Telecommunications", "Real Estate", "Energy", "Utilities"] }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "18f8fbd1-fa1d-4c67-9dd5-a2434ce1a6b5" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2025-10-08T06:35:46.901505+00:00" } }, "required": ["request_id", "timestamp"] } }, "required": ["results", "metadata"], "description": "Response containing available sectors for company filtering" }, "GetEntitiesByIdRequest": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Array of IDs (up to 100)", "example": ["D8442A", "3D4567", "6BD43B", "7373D4", "FE1757"], "maxItems": 100 } }, "required": ["values"], "description": "Request body for retrieving entities by RavenPack ID" }, "Entity": { "type": "object", "properties": { "id": { "type": "string", "description": "RavenPack ID", "example": "D8442A" }, "name": { "type": "string", "description": "Entity name", "example": "Apple Inc." }, "description": { "type": "string", "description": "Entity description", "example": "Apple Inc. (formerly Apple Computer Inc.), incorporated on January 03, 1977, designs, manufactures, and markets mobile communication and media devices, personal computing products, and portable digital music players worldwide." }, "type": { "type": "string", "description": "Entity type", "example": "PUBLIC" }, "country": { "type": "string", "description": "Country code", "example": "US" }, "sector": { "type": "string", "description": "Business sector", "example": "Technology" }, "industry_group": { "type": "string", "description": "Industry group", "example": "Computer Hardware" }, "industry": { "type": "string", "description": "Industry", "example": "Computer Hardware" }, "favicon": { "type": "string", "description": "Favicon URL", "example": "http://www.apple.com/favicon.ico" }, "webpage": { "type": "string", "description": "Website URL", "example": "http://www.apple.com" }, "isin_values": { "type": "array", "items": { "type": "string" }, "description": "ISIN values", "example": ["CA03785Y1007", "US0378331005"] }, "cusip_values": { "type": "array", "items": { "type": "string" }, "description": "CUSIP values", "example": ["037833100", "03785Y100"] }, "sedol_values": { "type": "array", "items": { "type": "string" }, "description": "SEDOL values", "example": ["2046251", "BNC31R1"] }, "listing_values": { "type": "array", "items": { "type": "string" }, "description": "Exchange listing identifiers", "example": ["XBKK:AAPL80", "XNAS:AAPL"] }, "category": { "type": "string", "description": "Entity category", "example": "companies" }, "position": { "type": "string", "description": "Position (for people)", "example": "Chief Executive Officer" }, "employer": { "type": "string", "description": "Employer (for people)", "example": "Apple Inc." }, "nationality": { "type": "string", "description": "Nationality (for people)", "example": "American" }, "gender": { "type": "string", "description": "Gender (for people)", "example": "Male" }, "continent": { "type": "string", "description": "Continent (for places)", "example": "North America" }, "type_name": { "type": "string", "description": "Type name (for concepts)", "example": "Currency" } }, "required": ["id", "name", "category"], "description": "Entity with detailed information" }, "GetEntitiesByIdResponse": { "type": "object", "properties": { "results": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity" }, "description": "Object containing RavenPack IDs as keys and entity data as values", "example": { "D8442A": { "id": "D8442A", "name": "Apple Inc.", "description": "Apple Inc. (formerly Apple Computer Inc.), incorporated on January 03, 1977, designs, manufactures, and markets mobile communication and media devices, personal computing products, and portable digital music players worldwide.", "type": "PUBLIC", "country": "US", "sector": "Technology", "industry_group": "Computer Hardware", "industry": "Computer Hardware", "favicon": "http://www.apple.com/favicon.ico", "webpage": "http://www.apple.com", "isin_values": [ "CA03785Y1007", "TH0150120408", "TH0241121001", "TH0809121500", "US0378331005" ], "cusip_values": [ "037833100", "03785Y100", "P0R684385", "Y100G4352", "Y49876132", "Y689DP202" ], "sedol_values": [ "2046251", "BNC31R1", "BPXWT99", "BRC1SP0", "BVBDDG1" ], "listing_values": [ "XBKK:AAPL80", "XNAS:AAPL" ], "category": "companies" }, "7373D4": { "id": "7373D4", "name": "iPhone", "description": "iPhone is a line of smartphones designed and marketed by Apple Inc. It runs Apple's iOS mobile operating system.The first generation iPhone, aka Iphone 2G was revealed on January 9, 2007.", "category": "products" }, "3D4567": { "id": "3D4567", "name": "United States of America", "description": "The United States of America is a country located in North America.", "type": "Country", "continent": "North America", "country": "US", "category": "places" }, "6BD43B": { "id": "6BD43B", "name": "Tim Cook", "description": "Timothy Donald Cook (born on the 1st of October 1960) is an American business executive who has been serving as the CEO of Apple Inc. since August 2011, succeeding Steve Jobs. He is known for his leadership in expanding Apple's product line and services.", "position": "Chief Executive Officer", "employer": "Apple Inc.", "nationality": "American", "gender": "Male", "category": "people" }, "FE1757": { "id": "FE1757", "name": "U.S. Dollar", "description": "The U.S. Dollar is the official currency of the United States of America. It is also the currency of Bonaire, Saint Eustatius and Saba, Marshall Islands, Palau, Puerto Rico, Panama, British Virgin Islands, East Timor, Guam, Northern Mariana Islands, U.S. Virgin Islands, Micronesia, British Indian Ocean Territory, Zimbabwe, Ecuador, Turks and Caicos Islands, United States Minor Outlying Islands, American Samoa, El Salvador. It was introduced in 1792.", "type_name": "Currency", "category": "concepts" } } }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "f9211cf6-3cd0-4cc7-9759-d33ed3f68a3f" }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamp of the response", "example": "2025-10-30T15:46:12.390150+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing entity data mapped by RavenPack ID" }, "GetCompanySubsidiariesRequest": { "type": "object", "properties": { "identifier": { "type": "object", "description": "Object specifying which identifier you are using to request the data. You must supply one type and its corresponding value.", "properties": { "type": { "type": "string", "enum": ["rp_entity_id"], "description": "Object specifying which identifier you are using to request the company subsidiaries. You must supply one type and its corresponding value.", "example": "rp_entity_id" }, "value": { "type": "string", "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Apple Inc. (D8442A)", "minLength": 6, "maxLength": 6, "example": "D8442A" } }, "required": ["type", "value"] } }, "required": ["identifier"], "description": "Request body for retrieving the subsidiary hierarchy of a company" }, "SubsidiaryRecord": { "type": "object", "properties": { "ultimate_parent_id": { "type": "string", "nullable": true, "description": "Entity ID of the ultimate parent, the topmost entity in the corporate tree, typically the holding company that directly or indirectly owns more than 50% stake in the subsidiaries below it" }, "ultimate_parent_name": { "type": "string", "nullable": true, "description": "Name of the ultimate parent company at the top of the corporate hierarchy" }, "immediate_parent_id": { "type": "string", "nullable": true, "description": "Entity ID of the immediate parent, the direct owner of this subsidiary, holding a 50% or greater stake in it" }, "immediate_parent_name": { "type": "string", "nullable": true, "description": "Name of the immediate parent company that directly owns this subsidiary" }, "identifier": { "type": "string", "description": "Entity ID of the subsidiary whose position in the corporate ownership structure is being described" }, "entity_name": { "type": "string", "nullable": true, "description": "Name of the subsidiary entity identified by the identifier field" }, "level": { "type": "integer", "description": "Depth in the corporate hierarchy relative to the ultimate parent (level 1 = the ultimate parent itself, level 2 = direct subsidiary, level 3 = grandchild subsidiary, and so on). Results only include level 2 and deeper." } }, "required": ["identifier", "level"] }, "GetCompanySubsidiariesResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/SubsidiaryRecord" }, "description": "List of subsidiaries in the corporate hierarchy" }, "errors": { "type": "array", "items": {}, "description": "List of errors if any occurred" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier" }, "timestamp": { "type": "string", "description": "ISO 8601 timestamp of when the response was generated" }, "rp_entity_id": { "type": "string", "description": "The queried entity ID" } }, "required": ["request_id", "rp_entity_id"] } }, "required": ["results", "metadata"], "description": "Response containing the subsidiary hierarchy for a given company" }, "FindOrganizationsRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for organizations by name or description. Examples: 'Federal Reserve', 'European Commission'", "example": "Federal Reserve" }, "types": { "type": "array", "items": { "type": "string" }, "description": "Organization types, as published in the `type` field of results (e.g., 'Central Bank', 'Bank', 'Council')", "example": ["Central Bank"] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "description": "Country codes using the ISO 3166-1 A-2 format (e.g., 'US' for United States, 'FR' for France, 'GB' for Great Britain)", "example": ["US"] }, "owners": { "type": "array", "items": { "type": "string" }, "description": "Names of the owning organization, as published in the `owner` field of results", "example": ["United States Government"] } }, "description": "Request body for finding organizations. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/organizations/values/{filter}`.", "example": { "query": "Federal Reserve", "types": ["Central Bank"], "countries": ["US"] } }, "FindOrganizationsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" }, "description": "Array of organizations results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "2a25111e-0043-4fe2-946e-668aa5af928a" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2026-07-02T13:24:45.163695+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing organizations results and metadata" }, "Organization": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier in the Knowledge Graph", "example": "F38FC4" }, "name": { "type": "string", "description": "Name", "example": "United States Federal Reserve" }, "description": { "type": "string", "description": "Description and overview", "example": "The Federal Reserve System is the central banking system of the United States of America. It was created on December 23, 1913." }, "type": { "type": "string", "description": "Organization type", "example": "Central Bank" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code (ISO 3166-1 alpha-2)", "example": "US" }, "owner": { "type": "string", "description": "Name of the owning organization" } }, "required": ["id", "name"], "description": "Organization entity with detailed information" }, "FindPeopleRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for people by name or description. Examples: 'Tim Cook', 'Christine Lagarde'", "example": "Tim Cook" }, "positions": { "type": "array", "items": { "type": "string" }, "description": "Positions, as published in the `position` field of results (e.g., 'Chief Executive Officer')", "example": ["Chief Executive Officer"] }, "employers": { "type": "array", "items": { "type": "string" }, "description": "Employers, as published in the `employer` field of results (e.g., 'Apple Inc.')", "example": ["Apple Inc."] }, "nationalities": { "type": "array", "items": { "type": "string" }, "description": "Nationalities, as published in the `nationality` field of results (e.g., 'American')", "example": ["American"] }, "genders": { "type": "array", "items": { "type": "string" }, "description": "Genders, as published in the `gender` field of results (e.g., 'Male', 'Female')", "example": ["Male"] } }, "description": "Request body for finding people. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/people/values/{filter}`.", "example": { "query": "Tim Cook", "employers": ["Apple Inc."] } }, "FindPeopleResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Person" }, "description": "Array of people results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "2a25111e-0043-4fe2-946e-668aa5af928a" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2026-07-02T13:24:45.163695+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing people results and metadata" }, "Person": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier in the Knowledge Graph", "example": "6BD43B" }, "name": { "type": "string", "description": "Name", "example": "Tim Cook" }, "description": { "type": "string", "description": "Description and overview", "example": "Timothy Donald Cook (born on the 1st of October 1960) is an American business executive who has been serving as the CEO of Apple Inc. since August 2011, succeeding Steve Jobs." }, "position": { "type": "string", "description": "Primary position held", "example": "Chief Executive Officer" }, "employer": { "type": "string", "description": "Primary employer", "example": "Apple Inc." }, "nationality": { "type": "string", "description": "Nationality", "example": "American" }, "gender": { "type": "string", "description": "Gender", "example": "Male" }, "short_description": { "type": "string", "description": "One-line description", "example": "CEO of Apple" } }, "required": ["id", "name"], "description": "Person entity with detailed information" }, "FindPlacesRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for places by name or description. Examples: 'Paris', 'Silicon Valley'", "example": "Paris" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Place categories, as published in the `category` field of results (e.g., 'Location', 'Facility')", "example": ["Location"] }, "types": { "type": "array", "items": { "type": "string" }, "description": "Place types, as published in the `type` field of results (e.g., 'City', 'Region', 'Facility')", "example": ["City"] }, "continents": { "type": "array", "items": { "type": "string" }, "description": "Continents, as published in the `continent` field of results (e.g., 'Europe')", "example": ["Europe"] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "description": "Country codes using the ISO 3166-1 A-2 format (e.g., 'US' for United States, 'FR' for France, 'GB' for Great Britain)", "example": ["FR"] }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Regions, as published in the `region` field of results (e.g., 'Ile-de-France Region'). Region names are long and vary by country, so list them with `GET /v1/knowledge-graph/places/values/regions` rather than constructing them", "example": ["Ile-de-France Region"] } }, "description": "Request body for finding places. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/places/values/{filter}`.", "example": { "query": "Paris", "types": ["City"], "countries": ["FR"] } }, "FindPlacesResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Place" }, "description": "Array of places results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "2a25111e-0043-4fe2-946e-668aa5af928a" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2026-07-02T13:24:45.163695+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing places results and metadata" }, "Place": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier in the Knowledge Graph", "example": "2C1E8B" }, "name": { "type": "string", "description": "Name", "example": "Paris" }, "description": { "type": "string", "description": "Description and overview", "example": "Paris is the capital city of France, located in the Ile-de-France region." }, "category": { "type": "string", "description": "Place category", "example": "Location" }, "type": { "type": "string", "description": "Place type", "example": "City" }, "continent": { "type": "string", "description": "Continent", "example": "Europe" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code (ISO 3166-1 alpha-2)", "example": "FR" }, "region": { "type": "string", "description": "Region", "example": "Ile-de-France Region" }, "alternative_name": { "type": "string", "description": "Fully qualified name", "example": "Paris, Ile-de-France Region, France" } }, "required": ["id", "name"], "description": "Place entity with detailed information" }, "FindProductsRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for products by name or description. Examples: 'iPhone', 'Model 3'", "example": "iPhone" }, "types": { "type": "array", "items": { "type": "string" }, "description": "Product types, as published in the `type` field of results (e.g., 'Mobile Phones')", "example": ["Mobile Phones"] }, "owners": { "type": "array", "items": { "type": "string" }, "description": "Names of the owning company, as published in the `owner` field of results (e.g., 'Apple Inc.')", "example": ["Apple Inc."] } }, "description": "Request body for finding products. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/products/values/{filter}`.", "example": { "query": "iPhone", "owners": ["Apple Inc."] } }, "FindProductsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "description": "Array of products results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "2a25111e-0043-4fe2-946e-668aa5af928a" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2026-07-02T13:24:45.163695+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing products results and metadata" }, "Product": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier in the Knowledge Graph", "example": "7373D4" }, "name": { "type": "string", "description": "Name", "example": "iPhone" }, "description": { "type": "string", "description": "Description and overview", "example": "iPhone is a line of smartphones designed and marketed by Apple Inc. It runs Apple's iOS mobile operating system." }, "type": { "type": "string", "description": "Product type", "example": "Mobile Phones" }, "owner": { "type": "string", "description": "Name of the owning company", "example": "Apple Inc." } }, "required": ["id", "name"], "description": "Product entity with detailed information" }, "FindConceptsRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for concepts by name or description. Examples: 'Inflation', 'Interest Rate'", "example": "Inflation" }, "types": { "type": "array", "items": { "type": "string" }, "description": "Concept types, as published in the `type` field of results (e.g., 'Economics', 'Business', 'Financial')", "example": ["Economics"] } }, "description": "Request body for finding concepts. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/concepts/values/{filter}`.", "example": { "query": "Inflation", "types": ["Economics"] } }, "FindConceptsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Concept" }, "description": "Array of concepts results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "2a25111e-0043-4fe2-946e-668aa5af928a" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2026-07-02T13:24:45.163695+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing concepts results and metadata" }, "Concept": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier in the Knowledge Graph", "example": "944F11" }, "name": { "type": "string", "description": "Name", "example": "Inflation" }, "description": { "type": "string", "description": "Description and overview", "example": "Inflation is the rate of increase in prices over a given period of time." }, "type": { "type": "string", "description": "Concept type", "example": "Economics" } }, "required": ["id", "name"], "description": "Concept entity with detailed information" }, "FindTopicsRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query to search for topics by name or description. Examples: 'Earnings', 'Board Member Appointment'", "example": "Earnings" }, "topics": { "type": "array", "items": { "type": "string" }, "description": "Top-level topics, as published in the `topic` field of results (e.g., 'business')", "example": ["business"] }, "groups": { "type": "array", "items": { "type": "string" }, "description": "Topic groups, as published in the `group` field of results (e.g., 'earnings', 'investor-relations')", "example": ["earnings"] }, "types": { "type": "array", "items": { "type": "string" }, "description": "Topic types, as published in the `type` field of results (e.g., 'earnings', 'earnings-call')", "example": ["earnings-call"] }, "subtypes": { "type": "array", "items": { "type": "string" }, "description": "Topic subtypes, as published in the `subtype` field of results", "example": [] } }, "description": "Request body for finding topics. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with `GET /v1/knowledge-graph/topics/values/{filter}`.", "example": { "query": "Earnings", "groups": ["earnings"] } }, "FindTopicsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Topic" }, "description": "Array of topics results" }, "metadata": { "type": "object", "properties": { "request_id": { "type": "string", "description": "Unique request identifier", "example": "2a25111e-0043-4fe2-946e-668aa5af928a" }, "timestamp": { "type": "string", "format": "date-time", "description": "Response timestamp", "example": "2026-07-02T13:24:45.163695+00:00" } }, "required": ["request_id", "timestamp"] }, "usage": { "$ref": "#/components/schemas/Usage", "description": "Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request." } }, "required": ["results", "metadata"], "description": "Response containing topics results and metadata" }, "Topic": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier in the Knowledge Graph", "example": "business,earnings,earnings,," }, "name": { "type": "string", "description": "Name", "example": "Earnings" }, "description": { "type": "string", "description": "Description and overview", "example": "Net income of a company" }, "topic": { "type": "string", "description": "Top-level topic", "example": "business" }, "group": { "type": "string", "description": "Topic group", "example": "earnings" }, "type": { "type": "string", "description": "Topic type", "example": "earnings" }, "subtype": { "type": "string", "description": "Topic subtype" } }, "required": ["id", "name"], "description": "Topic entity with detailed information" } } }, "security": [ { "ApiKeyAuth": [] } ], "paths": { "/v1/knowledge-graph/companies": { "post": { "tags": ["Companies"], "summary": "Find by details", "description": "Bigdata.com Knowledge Graph tracks over 7 million companies worldwide. Use this endpoint to search by name, website, ticker, or other market identifiers. Refine your results with filters such as company type, country, or sector.", "operationId": "findCompanies", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindCompaniesRequest" } } } }, "responses": { "200": { "description": "Successful response with company data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindCompaniesResponse" } } } } } } }, "/v1/knowledge-graph/companies/isin": { "post": { "tags": ["Companies"], "summary": "Get by ISIN", "description": "Locate companies using International Securities Identification Numbers (ISIN), enabling coverage of both equities and fixed income instruments.", "operationId": "getCompaniesByISIN", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISINRequest" } } } }, "responses": { "200": { "description": "Successful response with company data mapped by ISIN", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketIdResponse" } } } } } } }, "/v1/knowledge-graph/companies/cusip": { "post": { "tags": ["Companies"], "summary": "Get by CUSIP", "description": "Locate companies using Committee on Uniform Securities Identification Procedures (CUSIP) numbers, enabling coverage of both equities and fixed income instruments.", "operationId": "getCompaniesByCUSIP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CUSIPRequest" } } } }, "responses": { "200": { "description": "Successful response with company data mapped by CUSIP", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketIdResponse" } } } } } } }, "/v1/knowledge-graph/companies/sedol": { "post": { "tags": ["Companies"], "summary": "Get by SEDOL", "description": "Locate companies using Stock Exchange Daily Official List (SEDOL) numbers.", "operationId": "getCompaniesBySEDOL", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SEDOLRequest" } } } }, "responses": { "200": { "description": "Successful response with company data mapped by SEDOL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketIdResponse" } } } } } } }, "/v1/knowledge-graph/companies/listing": { "post": { "tags": ["Companies"], "summary": "Get by Listing", "description": "Locate companies using exchange listing identifiers.", "operationId": "getCompaniesByListing", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingRequest" } } } }, "responses": { "200": { "description": "Successful response with company data mapped by listing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketIdResponse" } } } } } } }, "/v1/knowledge-graph/etfs": { "post": { "tags": ["ETFs"], "summary": "Find by details", "description": "Find exchange-traded funds through a comprehensive search. Search by name, ticker, or description and filter by country to discover relevant ETFs for your investment research.", "operationId": "findETFs", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindETFsRequest" } } } }, "responses": { "200": { "description": "Successful response with ETF data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindETFsResponse" } } } } } } }, "/v1/knowledge-graph/sources": { "post": { "tags": ["Sources"], "summary": "Find by details", "description": "Locate and explore data sources and information providers within the knowledge graph. Filter sources by country, rank, and category to find the most relevant information providers.", "operationId": "findSources", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindSourcesRequest" } } } }, "responses": { "200": { "description": "Successful response with source data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindSourcesResponse" } } } } } } }, "/v1/knowledge-graph/organizations": { "post": { "tags": ["Organizations"], "summary": "Find by details", "description": "Find organizations such as central banks, regulators, government bodies and NGOs. Search by name or description and narrow the results by type, country, ultimate parent or owner.", "operationId": "findOrganizations", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindOrganizationsRequest" } } } }, "responses": { "200": { "description": "Successful response with organizations data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindOrganizationsResponse" } } } } } } }, "/v1/knowledge-graph/people": { "post": { "tags": ["People"], "summary": "Find by details", "description": "Find people such as executives, politicians and public figures. Search by name or description and narrow the results by position, employer, nationality or gender.", "operationId": "findPeople", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindPeopleRequest" } } } }, "responses": { "200": { "description": "Successful response with people data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindPeopleResponse" } } } } } } }, "/v1/knowledge-graph/places": { "post": { "tags": ["Places"], "summary": "Find by details", "description": "Find places such as countries, regions, cities and facilities. Search by name or description and narrow the results by category, type, continent, country or region.", "operationId": "findPlaces", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindPlacesRequest" } } } }, "responses": { "200": { "description": "Successful response with places data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindPlacesResponse" } } } } } } }, "/v1/knowledge-graph/products": { "post": { "tags": ["Products"], "summary": "Find by details", "description": "Find products and brands. Search by name or description and narrow the results by product type or owner.", "operationId": "findProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindProductsRequest" } } } }, "responses": { "200": { "description": "Successful response with products data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindProductsResponse" } } } } } } }, "/v1/knowledge-graph/concepts": { "post": { "tags": ["Concepts"], "summary": "Find by details", "description": "Find concepts such as economic indicators, financial instruments and business terms. Search by name or description and narrow the results by type.", "operationId": "findConcepts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindConceptsRequest" } } } }, "responses": { "200": { "description": "Successful response with concepts data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindConceptsResponse" } } } } } } }, "/v1/knowledge-graph/topics": { "post": { "tags": ["Topics"], "summary": "Find by details", "description": "Find topics from the Bigdata.com event taxonomy. Search by name or description and narrow the results by topic, group, type or subtype. Use the returned `id` in a Topic query filter.", "operationId": "findTopics", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindTopicsRequest" } } } }, "responses": { "200": { "description": "Successful response with topics data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindTopicsResponse" } } } } } } }, "/v1/knowledge-graph/{category}/values/{filter}": { "get": { "tags": ["Filter values"], "summary": "Get filter values", "description": "Retrieve every value a category filter can take, so a filter can be built without guessing its values. Values are returned in the exact form the corresponding search filter accepts: countries as ISO 3166-1 alpha-2 codes, source ranks as `RANK_1`..`RANK_5`, and so on.\n\nThe full sorted list is returned; there is no narrowing parameter, and lists are capped at 5000 values.\n\nEvery filter of every category is available except three on `sources`, which are stored in a way that cannot be enumerated and return 404: `packages`, `categories` and `tiers`.", "operationId": "getFilterValues", "parameters": [ { "name": "category", "in": "path", "required": true, "description": "Knowledge Graph category", "schema": { "type": "string", "enum": [ "companies", "concepts", "etfs", "organizations", "people", "places", "products", "sources", "topics" ] }, "example": "places" }, { "name": "filter", "in": "path", "required": true, "description": "Name of the filter to list values for, as it appears in that category's request body (e.g. `countries` for places, `ranks` for sources, `statuses` for ETFs)", "schema": { "type": "string" }, "example": "continents" } ], "responses": { "200": { "description": "Successful response with the values available for that filter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterValuesResponse" } } } }, "404": { "description": "Unknown category, unknown filter for that category, or a filter whose values cannot be enumerated" } } } }, "/v1/knowledge-graph/companies/sectors": { "get": { "tags": ["Companies"], "summary": "Get sectors", "description": "Retrieve the list of available sectors to be used as filters when searching for companies in the Knowledge Graph.\n\nThe same list is returned by `GET /v1/knowledge-graph/companies/values/sectors`, which lists the values of any category filter.", "operationId": "getSectors", "responses": { "200": { "description": "Successful response with available sectors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorsResponse" } } } } } } }, "/v1/knowledge-graph/subsidiaries/query": { "post": { "tags": ["Companies"], "summary": "Get Subsidiaries", "description": "Returns the full subsidiary hierarchy for a given company. For each subsidiary includes: ultimate parent, immediate parent, company name, and hierarchy depth level.", "operationId": "getCompanySubsidiaries", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompanySubsidiariesRequest" } } } }, "responses": { "200": { "description": "Successful response with subsidiary hierarchy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompanySubsidiariesResponse" }, "example": { "results": [ { "ultimate_parent_id": "D8442A", "ultimate_parent_name": "Apple Inc.", "immediate_parent_id": "D8442A", "immediate_parent_name": "Apple Inc.", "identifier": "07EB2B", "entity_name": "Apple Operations Ltd.", "level": 2 }, { "ultimate_parent_id": "D8442A", "ultimate_parent_name": "Apple Inc.", "immediate_parent_id": "MJT4QE", "immediate_parent_name": "Apple Retail Europe Ltd.", "identifier": "JY8BAE", "entity_name": "Apple Retail Sweden AB", "level": 4 } ], "errors": [], "metadata": { "request_id": "07b5eb7e-5e6f-4ebf-b597-e3b4a7aa4250", "timestamp": "2026-03-31T17:13:34.289840+00:00", "rp_entity_id": "D8442A" } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "429": { "description": "Too Many Requests" } } } }, "/v1/knowledge-graph/entities/id": { "post": { "tags": ["Entities"], "summary": "Get Entities by ID", "description": "Retrieve entities by their RavenPack ID, a unique identifier used across the Bigdata.com ecosystem. Users can retrieve up to 100 entities per request.", "operationId": "getEntitiesById", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEntitiesByIdRequest" } } } }, "responses": { "200": { "description": "Successful response with entity data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEntitiesByIdResponse" } } } } } } } } }