{"openapi":"3.0.0","info":{"title":"The Data City API (v2)","description":"API v2. Use these endpoints for new integrations.","version":"2.0.0"},"servers":[{"url":"https://product-api.thedatacity.com/api/","description":"API base URL"}],"paths":{"/v2/classification/classify":{"post":{"tags":["classification"],"summary":"Classify companies","description":"Classify companies.","operationId":"69474865192623aab20008e6f48f8343","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostClassifyCompaniesBody"}}}},"responses":{"200":{"description":"Classify / score results from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilteredCompaniesResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["companies:classify"]}]}},"/v2/companies/export":{"post":{"tags":["companies"],"summary":"Export list","operationId":"d99cf38f4b43c990632b12c792a1db8e","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostV2CompaniesExportBody"}}}},"responses":{"200":{"description":"Export payload or file metadata from the product API (format depends on DownloadFormat).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductApiPassthroughObject"}}}}},"security":[{"bearerAuth":[]},{"auth":["companies:downloadList"]}]}},"/v2/companies/export/download/{file}":{"get":{"tags":["companies"],"summary":"Download an export file","description":"Stream an export file through the public API.","operationId":"a4b4a382f507ccc49fa3eada3b009dc7","parameters":[{"name":"file","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The export file."},"404":{"description":"File not found."}}}},"/v2/companies/{companyNumber}":{"get":{"tags":["companies"],"summary":"Get company details","operationId":"f89b4b784503722005bdfee35e109030","parameters":[{"$ref":"#/components/parameters/ApiPathCompanyNumber"}],"responses":{"200":{"description":"Company record from the product API (field-level shape in data dictionary).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassifiedCompany"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:companyDetails"]}]}},"/v2/companies/{companyNumber}/group-structure":{"get":{"tags":["companies"],"summary":"Get company group structure","description":"Group structure (parent / subsidiary rows) for a company.","operationId":"ae18f287824768a0d75cca0bf1d618e1","parameters":[{"$ref":"#/components/parameters/ApiPathCompanyNumber"}],"responses":{"200":{"description":"Group structure rows from the product API (data dictionary GroupStructureDetails).","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupStructureDetails"}}}}}},"security":[{"bearerAuth":[]},{"auth":["companies:read","companies:companyDetails"]}]}},"/v2/companies/by-website":{"get":{"tags":["companies"],"summary":"List companies by website URL (GET)","description":"Active companies for one normalised website URL (paged; query string).","operationId":"3bc8c29c6a4b6ebcd6b8551d283a9726","parameters":[{"$ref":"#/components/parameters/V2CompaniesByWebsiteUrl"},{"$ref":"#/components/parameters/V2CompaniesByWebsiteSkip"},{"$ref":"#/components/parameters/V2CompaniesByWebsiteReturnCount"}],"responses":{"200":{"description":"Paged companies for the URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesByWebsiteResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["companies:read","companies:companyDetails","companies:byWebsite"]}]},"post":{"tags":["companies"],"summary":"List companies by website URL (POST body)","description":"Same as GET by-website but accepts the URL in the JSON body (for long URLs).","operationId":"6dbad4cf978f66b09ccd0e5e9aeac86f","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CompaniesByWebsitePostBody"}}}},"responses":{"200":{"description":"Paged companies for the URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesByWebsiteResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["companies:read","companies:companyDetails","companies:byWebsite"]}]}},"/v2/companies/by-website/batch":{"post":{"tags":["companies"],"summary":"List companies by multiple website URLs","description":"Union of active companies matching any of the website URLs (paged).","operationId":"4f7c20db2fa99e96ee5bb69950060915","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CompaniesByWebsiteBatchPostBody"}}}},"responses":{"200":{"description":"Union of matches for all URLs (same envelope as single-URL by-website).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesByWebsiteResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["companies:read","companies:companyDetails","companies:byWebsite"]}]}},"/v2/companies":{"post":{"tags":["companies"],"summary":"List companies by filter","operationId":"8803ba08f5fa9015a6e193b8ef05f7b9","parameters":[{"$ref":"#/components/parameters/ApiQueryInsights"},{"name":"fields[companies]","in":"query","description":"Comma-separated company fields to include per row (sparse fieldset). Unknown fields return 400 from the upstream API.","required":false,"schema":{"type":"string","example":"CompanyNumber,CompanyName,BestEstimateEmployees"}},{"name":"fieldset","in":"query","description":"Comma-separated predefined field groups (union with fields[companies]).","required":false,"schema":{"type":"string","example":"identity"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostFilteredCompaniesRequestBody"}}}},"responses":{"200":{"description":"Filtered companies from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilteredCompaniesResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["companies:filteredCompanies","rtic:filteredCompanies"]}]}},"/v2/companies/check":{"post":{"tags":["companies"],"summary":"Check companies exist","operationId":"2a9502a22770f6b39f5f5670dce1d4d3","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCheckCompanyNumbersBody"}}}},"responses":{"200":{"description":"Per-number existence flags from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCheckCompaniesResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:check"]}]}},"/v2/companies/batch":{"post":{"tags":["companies"],"summary":"Get multiple company details","description":"Get the details of multiple companies in a single request.","operationId":"61f433a51baad141e2370eb46adfb3d4","parameters":[{"$ref":"#/components/parameters/ApiQueryIncludeSimilarCompanies"},{"$ref":"#/components/parameters/ApiQueryIncludeSimilarCompositeCompanies"},{"$ref":"#/components/parameters/ApiQueryIncludeChangelog"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostV2CompaniesBatchArrayBody"}}}},"responses":{"200":{"description":"Batch of company detail objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDetailsBatchResponseBody"}}}},"400":{"description":"Too many company numbers supplied or invalid payload"}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:companyDetails"]}]}},"/v2/directors/{personNumber}":{"get":{"tags":["directors"],"summary":"Get director details","operationId":"f08f7563aae301533d3a28f0d55629e4","parameters":[{"$ref":"#/components/parameters/ApiPathPersonNumber"}],"responses":{"200":{"description":"Director / officer record from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Officer"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:directorsDetails"]}]}},"/v2/explore/{listId}":{"get":{"tags":["explore"],"summary":"Get explore list details","description":"Get explore list details.","operationId":"0a0ad929551d1b681222e5134920ea2b","parameters":[{"$ref":"#/components/parameters/ApiPathListId"},{"$ref":"#/components/parameters/ApiQueryPaginationReturnCountList"},{"$ref":"#/components/parameters/ApiQueryPaginationSkip"},{"$ref":"#/components/parameters/ApiQueryCompanyStatus"},{"$ref":"#/components/parameters/ApiQueryExploreInsights"}],"responses":{"200":{"description":"List name plus filtered companies from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListOrExploreListResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:exploreList"]}]}},"/v2/explore/by-domain/{domain}":{"get":{"tags":["explore"],"summary":"Get explore lists by domain","description":"Get explore lists by domain.","operationId":"34ea8e95ffaf5f00c4ae76738e4f464c","parameters":[{"$ref":"#/components/parameters/ApiPathDomain"}],"responses":{"200":{"description":"Explore list IDs from the platform database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListIdsResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:exploreList"]}]}},"/v2/explore/by-email/{email}":{"get":{"tags":["explore"],"summary":"Get explore lists by email","description":"Get explore lists by email.","operationId":"6dbb6871eba2a0ce80ee4e5798cbc246","parameters":[{"$ref":"#/components/parameters/ApiPathEmail"}],"responses":{"200":{"description":"Explore list IDs from the platform database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListIdsResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:exploreList"]}]}},"/v2/filters":{"get":{"tags":["filters"],"summary":"Get filters","operationId":"a77f7c893251d1ac3c224e874fee68e4","responses":{"200":{"description":"Filter metadata from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductApiPassthroughObject"}}}}},"security":[{"bearerAuth":[]},{"auth":["read"]}]},"post":{"tags":["filters"],"summary":"Get filters with criteria","operationId":"aed3fc5db224ead388c59766f04f0519","requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostFiltersCriteriaBody"}}}},"responses":{"200":{"description":"Filter metadata from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductApiPassthroughObject"}}}}},"security":[{"bearerAuth":[]},{"auth":["read"]}]}},"/v2/smart-lists/{listId}":{"get":{"tags":["smart-lists"],"summary":"Get list details","description":"Get list details.","operationId":"8fb6e58b507634cfafd48952c606e56b","parameters":[{"$ref":"#/components/parameters/ApiPathListId"},{"$ref":"#/components/parameters/ApiQueryPaginationReturnCountList"},{"$ref":"#/components/parameters/ApiQueryPaginationSkip"},{"$ref":"#/components/parameters/ApiQueryIncludeFilters"},{"$ref":"#/components/parameters/ApiQueryCompanyStatus"}],"responses":{"200":{"description":"List name plus classify response from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListOrExploreListResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:userList"]}]}},"/v2/smart-lists/by-domain/{domain}":{"get":{"tags":["smart-lists"],"summary":"Get lists by domain","description":"Get lists by domain.","operationId":"23b87f9a11ee84d17ee397d9cade9bd0","parameters":[{"$ref":"#/components/parameters/ApiPathDomain"}],"responses":{"200":{"description":"Smart list IDs from the platform database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListIdsResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:userList"]}]}},"/v2/smart-lists/by-email/{email}":{"get":{"tags":["smart-lists"],"summary":"Get lists by email","description":"Get lists by email.","operationId":"e6aa3e899301cc9d3fc8d5799f19cc7e","parameters":[{"$ref":"#/components/parameters/ApiPathEmail"}],"responses":{"200":{"description":"Smart list IDs from the platform database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListIdsResponseBody"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:companies","companies:userList"]}]}},"/v2/rtics":{"get":{"tags":["rtics"],"summary":"RTIC details","operationId":"b66ce1afc699a9df36940b3b9155c22b","responses":{"200":{"description":"RTIC catalogue / metadata (shape from platform service).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductApiPassthroughObject"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:rtic","rtic:rticDetails"]}]}},"/v2/search/aheadFull/{companyNumber}":{"get":{"tags":["search"],"summary":"Search by company number","operationId":"7a2dfc57a45ffc86530428a91012eb75","parameters":[{"$ref":"#/components/parameters/ApiPathCompanyNumber"}],"responses":{"200":{"description":"Type-ahead / search hits from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductApiPassthroughObject"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:search","search:aheadFull"]}]}},"/v2/search/fullText/{keyword}":{"get":{"tags":["search"],"summary":"Full-text search","operationId":"cde5db118eac75312e1fdf66766ccfe1","parameters":[{"$ref":"#/components/parameters/ApiPathSearchKeyword"}],"responses":{"200":{"description":"Full-text search results from the product API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductApiPassthroughObject"}}}}},"security":[{"bearerAuth":[]},{"auth":["read:search","search:fullText"]}]}}},"components":{"schemas":{"BasicGrant360":{"description":"Generated from The Data City data dictionary (schema BasicGrant360, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"ImpactCategory":{"description":"The impact category of the grant.","type":"string"},"Primaryissue":{"description":"The primary issue the grant is for.","type":"string"},"amountAwarded":{"description":"The amount awarded.","type":"number","format":"double"},"awardDate":{"description":"The date the grant was awarded.","type":"string","format":"date-time"},"currency":{"description":"The currency of the grant.","type":"string"},"description":{"description":"A description of the grant.","type":"string"},"funderName":{"description":"The name of the funder.","type":"string"},"grantProgrammeTitle":{"description":"The title of the grant programme.","type":"string"},"recipientName":{"description":"The name of the recipient.","type":"string"},"recipientURL":{"description":"The URL of the recipient.","type":"string"},"title":{"description":"The title of the grant.","type":"string"}},"type":"object"},"ClassifiedCompany":{"description":"Generated from The Data City data dictionary (schema ClassifiedCompany, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"AccountsOverdueByMoreThanAYear":{"description":"A flag indicating the company's accounts are overdue by more than a year.","type":"boolean"},"BestEstimateEBITDA":{"description":"Where OPERATING_PROFIT, DEPRECIATION_OF_TANGIBLES and AMORTISATION_OF_INTANGIBLES are available, these three values are summed.","type":"number","format":"double"},"BestEstimateEmployees":{"description":"Employees data is available for most companies. Occasionally there are gaps in reporting. Where there are gaps in reporting, we estimate the number of employees; this includes a projection of employees forwards and backwards. BestEstimateEmployees refers to the current year. BestEstimateEmployees may include overseas employees.","type":"integer","format":"int64"},"BestEstimateTurnover":{"description":"Available from Companies House for large companies, if absent then The Data City provide an estimate. The BestEstimate will report actual (reported) where available or it will be an estimate. BestEstimateTurnover refers to the current year: where accounts covering the current year have not been reported, the value is projected forward from the most recently reported year.","type":"integer","format":"int64"},"BestEstimateUKEmployees":{"description":"Similar to BestEstimateEmployees, but estimates only UK-based employees. BestEstimateUKEmployees currently refers to the latest complete year.","type":"integer","format":"int64"},"Bluesky":{"description":"Takes the most common anchor link which contains the social media domain. We prioritise social media links that are found on the homepage.","type":"string"},"CICs":{"description":"Custom Industrial Classifications (CICs) the company has been classified into. API includes the industry verticals within the same field. On the download, verticals are a separate column. These are custom RTICs.","type":"array","items":{"$ref":"#/components/schemas/CompanyNumberRtic"}},"CompanyCategory":{"description":"Companies House data. The type of company, e.g. Publically Listed (PLC) or Limited (LTD).","type":"string"},"CompanyDescription":{"description":"Takes the description from the description meta tag from the homepage and the about page. We check this is in English.","type":"string"},"CompanyExports":{"description":"HMRC export trade data for the company.","type":"array","items":{"$ref":"#/components/schemas/CompanyTrade"}},"CompanyFinancials_CreditSafe":{"description":"Annual financial reporting from filings processed by Creditsafe. Creditsafe use a semi-automated process to convert scanned financial PDF documents into numerical/digital values. This process may lead to errors, e.g. reporting profit as turnover.","type":"array","items":{"$ref":"#/components/schemas/CleanCreditSafeCompany"}},"CompanyGrowthTrends":{"$ref":"#/components/schemas/CompanyGrowthTrend"},"CompanyImports":{"description":"HMRC import trade data for the company.","type":"array","items":{"$ref":"#/components/schemas/CompanyTrade"}},"CompanyJobPostings":{"description":"This company's job postings grouped by SOC4 occupation, one entry per occupation group, covering the most recent five years. See the CompanyJobPosting schema for the fields on each entry. Job postings data is a paid upgrade and is not included for all customers.","type":"array","items":{"$ref":"#/components/schemas/CompanyJobPosting"}},"CompanyJobPostingsByLOTCodeOverTime":{"description":"This company's monthly job posting counts and median advertised salary per LOT occupation, one entry per occupation per month, covering the most recent five years. Job postings data is a paid upgrade and is not included for all customers.","type":"array","items":{"$ref":"#/components/schemas/CompanyJobPostingByLOTCodeOverTime"}},"CompanyJobPostingsByLot":{"description":"This company's job postings grouped by Lightcast Occupation Taxonomy (LOT) occupation, one entry per occupation, covering the most recent five years. See the CompanyJobPostingByLot schema for the fields on each entry. Job postings data is a paid upgrade and is not included for all customers.","type":"array","items":{"$ref":"#/components/schemas/CompanyJobPostingByLot"}},"CompanyJobPostingsBySOC4CodeOverTime":{"description":"This company's monthly job posting counts and median advertised salary per SOC4 occupation, one entry per occupation per month, covering the most recent five years. Job postings data is a paid upgrade and is not included for all customers.","type":"array","items":{"$ref":"#/components/schemas/CompanyJobPostingBySOC4CodeOverTime"}},"CompanyJobPostingsBySkill":{"description":"This company's job postings grouped by common skill requested, covering the most recent five years. Despite the name this holds common skills only; specialised skills, software skills and certifications are returned separately and are not included here. See the CompanyJobPostingByCommonSkill schema for the fields on each entry. Job postings data is a paid upgrade and is not included for all customers.","type":"array","items":{"$ref":"#/components/schemas/CompanyJobPostingByCommonSkill"}},"CompanyJobPostingsOverTime":{"$ref":"#/components/schemas/CompanyJobPostingsOverTime"},"CompanyName":{"description":"Companies House data. Companies have the ability to change their company name through submission to Companies House.","type":"string"},"CompanyNation":{"description":"The company nation.","type":"string"},"CompanyNumber":{"description":"Companies House data. Unique key, doesn't change. Most important part of our data.","type":"string"},"CompanyStatus":{"description":"The company status as per Companies House.","type":"string"},"ConsolidatedAccountsCompanyName":{"description":"A list of company names within the same group structure that have consolidated accounts. This is a strong signal of the companies that are more likely to be the parent company. This is because it is common for the parent company to file consolidated accounts that include all the subsidiaries in the group structure.","type":"array","items":{"type":"string"}},"ConsolidatedAccountsCompanyNumber":{"description":"A list of company numbers within the same group structure that have consolidated accounts. This is a strong signal of the companies that are more likely to be the parent company. This is because it is common for the parent company to file consolidated accounts that include all the subsidiaries in the group structure.","type":"array","items":{"type":"string"}},"CountryOfOrigin":{"description":"Companies House data. Not to be confused with group structure (ParentCompanyNation, UltimateParentCompanyNation).","type":"string"},"DealroomFunding":{"description":"Legacy field, retained for backward compatibility only; use Investment instead.","type":"array","items":{"$ref":"#/components/schemas/PerRoundInvestment"}},"DistinctBrandsInGroup":{"description":"A list of distinct brands that can be found across the company's group structure.","type":"array","items":{"$ref":"#/components/schemas/DistinctBrandInfo"}},"ESGStatementAnchors":{"description":"This is an array of ESG statement anchors. Each anchor is a string that is found in the company's website text.","type":"array","items":{"$ref":"#/components/schemas/ESGStatementAnchor"}},"ESG_RTIC":{"description":"A boolean value indicating whether the company is in an ESG RTIC.","type":"boolean"},"EmailAddresses":{"description":"Emails are extracted from the website text. Director emails are prioritised. For matching directors to emails: any combination of the complete surname or first name with at least the first initial of the opposing field. No AI is used.","type":"array","items":{"type":"string"}},"EstimatedGVA":{"description":"We have produced an estimated GVA measure at the company level. We have employee and SIC information for each company. This makes it possible to estimate a GVA value per company by multiplying a company's number of employees by the standard GVA employee contribution associated with that same company's SIC.","type":"number","format":"double"},"EstimatedUKGVA":{"description":"We have produced an estimated GVA measure at the company level. We have employee and SIC information for each company. This makes it possible to estimate a GVA value per company by multiplying a company's number of UK employees by the standard GVA employee contribution associated with that same company's SIC.","type":"number","format":"double"},"Facebook":{"description":"Takes the most common anchor link which contains the social media domain. We prioritise social media links that are found on the homepage.","type":"string"},"GenderFoundedCategory":{"description":"The company's single gender-leadership category based on its active founders. One of: All women led, Majority women led, Mixed led, Majority men led, All men led, Uncertain. Mutually exclusive \u2014 every company falls in exactly one.","type":"string"},"GenderLedCategory":{"description":"The company's single gender-leadership category based on its active directors. One of: All women led, Majority women led, Mixed led, Majority men led, All men led, Uncertain. Mutually exclusive \u2014 every company falls in exactly one.","type":"string"},"HasBeenAcquired":{"description":"True if the company has been acquired, based on funding rounds with an 'Acquisition' round type where this company is the target.","type":"boolean"},"HasIPO":{"description":"True if the company has listed on a public market, based on an IPO event in the investment feed.","type":"boolean"},"HasMadeAcquisitions":{"description":"True if the company has acquired another company, based on funding rounds with an 'Acquisition' round type where this company is the acquirer.","type":"boolean"},"HighGrowth":{"description":"A boolean value indicating whether the company is a high growth company.","type":"boolean"},"Homepage_domain":{"description":"Goes through the large web-scraping/matching process.","type":"string"},"IS8Codes":{"description":"Industrial Strategy Sector codes associated with the company, derived from RTICs and RSICs.","type":"array","items":{"$ref":"#/components/schemas/IndustrialStrategySector"}},"IncorporationDate":{"description":"Companies House data.","type":"string","format":"date"},"InnovateUKFunding":{"description":"Information about the projects funded by Innovate UK from 2004. Source: https://www.ukri.org/publications/innovate-uk-funded-projects-since-2004/","type":"array","items":{"$ref":"#/components/schemas/InnovateUKFundingClean"}},"InnovationKeywords":{"description":"We have a large list of emerging economy keywords. We loop through the web text to see if the web text contains the keyword. If they do, the keyword is assigned to the company.","type":"array","items":{"type":"string"}},"InnovationScore":{"description":"We present this on the platform as stars but the API is actually a numerical value which gets categorised. The result is a binary classifier. The company is either innovative or it is not. The confidence increases the higher the score.","type":"number","format":"double"},"Instagram":{"description":"Takes the most common anchor link which contains the social media domain. We prioritise social media links that are found on the homepage.","type":"string"},"Investment":{"description":"Per-round investment data matched to a CompanyNumber with high confidence. TotalInvestmentRaised_GBP_Million is the sum of all rounds, _except_ Debt and Acquisition rounds. This is the total across the provider's tracking period and is not the total in one particular year.","type":"array","items":{"$ref":"#/components/schemas/PerRoundInvestment"}},"IsBCorp":{"description":"A flag of whether a company is a B Corp. This is based on a list of B Corps that we have obtained from B Corp and matched to our companies.","type":"boolean"},"IsLikelyAgency":{"description":"A boolean value indicating whether the company is likely to be an agency. This is based on assessment of the company's financials.","type":"boolean"},"IsLikelySPV":{"description":"A flag indicating the company is likely a special purpose vehicle (SPV), based on an ML model applied to Companies House data.","type":"boolean"},"LatestRoundAmount":{"description":"The amount raised in the company's most recent funding round. This is the individual round amount, not the company's total funding raised across all rounds.","type":"number","format":"double"},"LatestRoundDate":{"description":"The date of the company's most recent funding round.","type":"string","format":"date-time"},"LatestRoundType":{"description":"The round type of the company's most recent funding round (e.g. 'Seed', 'Series A').","type":"string"},"LatestRoundValuation":{"description":"The company's valuation as reported for its most recent funding round, in GBP. Not all rounds have a disclosed or estimated valuation.","type":"number","format":"double"},"LinkedCompanyNumbers":{"description":"A list of company numbers that are linked to the company, even if they are not connected through group structure. This is based on a combination of signals including shared officers, shared addresses, shared shareholders, and other signals.","type":"array","items":{"type":"string"}},"Linkedin":{"description":"Takes the most common anchor link which contains the social media domain. We prioritise social media links that are found on the homepage.","type":"string"},"LocationDetails":{"description":"An array of location objects with postcode-related fields.","type":"array","items":{"$ref":"#/components/schemas/PostcodeDetail_grouped"}},"ManufacturingKeywords":{"description":"We have a large list of manufacturing keywords. We loop through the web text to see if the web text contains the keyword. If they do, the keyword is assigned to the company.","type":"array","items":{"type":"string"}},"NumberOfCurrentDirectors":{"description":"The number of directors currently appointed to the company, i.e. those with no resignation date recorded whose role is Director. Excludes other officer roles such as company secretaries, LLP members and managing officers, so a limited liability partnership will typically report zero current directors.","type":"integer","format":"int32"},"NumberOfCurrentOfficers":{"description":"The number of officers currently appointed to the company, i.e. those with no resignation date recorded. Counts all officer roles, including company secretaries and LLP members, not only directors.","type":"integer","format":"int32"},"OECDScaleup":{"description":"A boolean value indicating whether the company is an OECD defined scale-up.","type":"boolean"},"Officers":{"description":"These are officers as per Companies House. E.g. https://find-and-update.company-information.service.gov.uk/company/10958787/officers","type":"array","items":{"$ref":"#/components/schemas/Officer"}},"ParentNation":{"description":"The nation of the parent company.","type":"string"},"PhoneNumbers":{"description":"CreditSafe provide The Data City with CTPS approved phone numbers. Phone numbers are extracted from the website text.","type":"array","items":{"type":"string"}},"RSICs":{"description":"Real-Time SIC (RSIC) codes with associated confidence score","type":"array","items":{"$ref":"#/components/schemas/RSIC"}},"RTICs":{"description":"RTICs the company has been classified into. API includes the industry verticals within the same field. On the download, verticals are a separate column.","type":"array","items":{"$ref":"#/components/schemas/CompanyNumberRtic"}},"RegisteredAddress":{"description":"Companies House data. The companies registered address as registered on Companies House. This is not to be confused with their head office. Not sourced from CreditSafe.","type":"string"},"RegisteredPostcode":{"description":"Companies House data. Not to be confused with head office (we do not know this at this stage). Not sourced from CreditSafe.","type":"string"},"SICHLUs":{"description":"Companies House data. SIC Sections. Nature of business: Standard Industrial Classification (SIC) codes.","type":"array","items":{"type":"string"}},"SICs":{"description":"Companies House data. Nature of business: Standard Industrial Classification (SIC) codes.","type":"array","items":{"type":"string"}},"SectorKeywords":{"description":"We have a large list of emerging economy keywords. We loop through the web text to see if the web text contains the keyword. If they do, the keyword is assigned to the company.","type":"array","items":{"type":"string"}},"SimilarCompanies":{"description":"Our similarity score adopts measures of mathematical similarity to find similar companies using their website text. Companies with website text with the same words are more likely to report a higher level of similarity.","type":"array","items":{"$ref":"#/components/schemas/CompanySimilarity"}},"SimilarCompositeCompanies":{"description":"Our composite similarity score.","type":"array","items":{"$ref":"#/components/schemas/CompanySimilarity"}},"Spinout":{"description":"True if the company is a spinout, sourced from the HESA spinout register. A spinout is a company created to commercialise research or technology developed at a university or research institution.","type":"boolean"},"TonnesOfC02equivGHGPerYear":{"description":"We estimate greenhouse gas emissions based on a published table of total carbon emissions by SIC sector. We assume that carbon emissions are spread equally across all companies within the SIC sector in proportion to their number of employees. Therefore, we only hold an estimate for a limited number of companies.","type":"number","format":"double"},"Twitter":{"description":"Takes the most common anchor link which contains the social media domain. We prioritise social media links that are found on the homepage.","type":"string"},"URLMatchStats":{"$ref":"#/components/schemas/UrlMatchStat"},"UltimateLinkedCompanyNumber":{"description":"The ultimate linked company number in the group structure. This is the company number that was first incorporated within the collection of linked companies.","type":"string"},"UltimateParentNation":{"description":"The nation of the ultimate parent company.","type":"string"},"UltimateUKParentCompanyNames":{"description":"A list of company names belonging to companies in the group that are the highest level UK registered companies.","type":"array","items":{"type":"string"}},"UltimateUKParentCompanyNumbers":{"description":"A list of company numbers belonging to companies in the group that are the highest level UK registered companies.","type":"array","items":{"type":"string"}},"WomenLedStats":{"$ref":"#/components/schemas/WomanLedStats"},"Youtube":{"description":"Takes the most common anchor link which contains the social media domain. We prioritise social media links that are found on the homepage.","type":"string"},"_360GivingFunding":{"description":"Data provided by a charity that helps organisations to publish open, standardised grants data, and supports people to use it to improve charitable giving. Source: https://grantnav.threesixtygiving.org/","type":"array","items":{"$ref":"#/components/schemas/BasicGrant360"}}},"type":"object"},"CleanCreditSafeCompany":{"description":"Generated from The Data City data dictionary (schema CleanCreditSafeCompany, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"ACCOUNTANT_NAME":{"description":"Accountant name.","type":"string"},"ACCOUNTS_FORMAT":{"description":"Format of the submitted accounts.","type":"string"},"AMORTISATION_OF_INTANGIBLES":{"description":"Amortisation of intangibles.","type":"integer","format":"int64"},"AUDITORS":{"description":"Auditors.","type":"string"},"BANK_OVERDRAFT":{"description":"Bank overdraft.","type":"integer","format":"int64"},"CASH":{"description":"Cash at bank in hand.","type":"integer","format":"int64"},"CONSOLIDATED_ACS":{"description":"Boolean. True if the financials are consolidated.","type":"boolean"},"CREDITORS":{"description":"Creditors.","type":"integer","format":"int64"},"CURRENCY":{"description":"Currency the financials are reported in.","type":"string"},"DEBTORS":{"description":"Debtors.","type":"integer","format":"int64"},"DEBTORS_DUE_AFTER_ONE_YEAR":{"description":"Debtors due after one year.","type":"integer","format":"int64"},"DECREASE_OR_INCREASE_IN_CASH":{"description":"Decrease or increase in cash.","type":"integer","format":"int64"},"DEPRECIATION_OF_TANGIBLES":{"description":"Depreciation of tangibles.","type":"integer","format":"int64"},"EBITDA":{"description":"A calculation. OPERATING_PROFIT + DEPRECIATION_OF_TANGIBLES + AMORTISATION_OF_INTANGIBLES","type":"integer","format":"int64"},"EMPLOYEES_ANOMALOUS":{"description":"Boolean. True if the number of employees is declared as anomalous.","type":"boolean"},"EMPLOYEES_ANOMALOUS_PROBABILITY":{"description":"Float. The probability that the number of employees is declared as anomalous. 0.5 is the threshold.","type":"number","format":"double"},"EXPORT":{"description":"Export.","type":"integer","format":"int64"},"GROUP_DEBTORS":{"description":"Group debtors.","type":"integer","format":"int64"},"LIKELY_AGENCY":{"description":"Boolean. True if the company is likely an agency.","type":"boolean"},"LIKELY_AGENCY_PROBABILITY":{"description":"Float. The probability that the company is likely an agency. 0.5 is the threshold.","type":"number","format":"double"},"MADE_FROM_DATE":{"description":"Accounting From Date (ISO 8601 string).","type":"string","format":"date-time"},"MADE_UPTO_DATE":{"description":"Accounting To Date (ISO 8601 string).","type":"string","format":"date-time"},"NET_ASSETS":{"description":"Net assets.","type":"integer","format":"int64"},"NET_WORTH":{"description":"Net worth of the company.","type":"integer","format":"int64"},"NUMBER_OF_EMPLOYEES":{"description":"Employees as submitted to Companies House.","type":"integer","format":"int64"},"NUM_OF_MONTHS":{"description":"Number of months the financials cover.","type":"integer","format":"int32"},"OPERATING_PROFIT":{"description":"Operating profit.","type":"integer","format":"int64"},"PRE_TAX_PROFIT":{"description":"Pre-tax profit.","type":"integer","format":"int64"},"PROFIT_AFTER_TAX":{"description":"Profit after tax.","type":"integer","format":"int64"},"SHAREHOLDER_FUNDS":{"description":"Shareholder funds.","type":"integer","format":"int64"},"TOTAL_ASSETS":{"description":"Total assets.","type":"integer","format":"int64"},"TOTAL_CURRENT_ASSETS":{"description":"Total current assets.","type":"integer","format":"int64"},"TOTAL_CURRENT_LIABILITIES":{"description":"Total current liabilities.","type":"integer","format":"int64"},"TOTAL_LIABILITIES":{"description":"Total liabilities.","type":"integer","format":"int64"},"TRADE_DEBTORS":{"description":"Trade debtors.","type":"integer","format":"int64"},"TURNOVER":{"description":"Turnover as submitted to Companies House.","type":"integer","format":"int64"},"TURNOVER_ANOMALOUS":{"description":"Boolean. True if the declared turnover is anomalous.","type":"boolean"},"TURNOVER_ANOMALOUS_PROBABILITY":{"description":"Float. The probability that the declared turnover is anomalous. 0.5 is the threshold.","type":"number","format":"double"},"WAGES_AND_SALARIES":{"description":"Wages and salaries.","type":"integer","format":"int64"},"YEAR":{"description":"Year ending.","type":"integer","format":"int32"}},"type":"object"},"CompanyGrowthTrend":{"description":"Generated from The Data City data dictionary (schema CompanyGrowthTrend, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"BestEstimateCurrentEmployees":{"description":"The best estimate of the current number of employees.","type":"integer","format":"int64"},"BestEstimateCurrentTurnover":{"description":"The best estimate of the current turnover.","type":"integer","format":"int64"},"BestEstimateEmployeeGrowthPercentagePerYear":{"description":"Employment growth percentage per year.","type":"number","format":"double"},"BestEstimateGrowthPercentagePerYear":{"description":"The company's headline annual growth rate. Always equal to BestEstimateEmployeeGrowthPercentagePerYear: the annual employment growth rate from a log-linear fit across the company's reliable filed employee years (positive, non-anomalous values; at least three required, otherwise this is null). Also drives our employment projections. Never an average with BestEstimateTurnoverGrowthPercentagePerYear, which is reported separately and plays no part here, and plays no part in the OECDScaleup flag, \u2026","type":"number","format":"double"},"BestEstimateTurnoverGrowthPercentagePerYear":{"description":"Turnover growth percentage per year.","type":"number","format":"double"},"BestEstimatedTurnoverToEmployeeRatio":{"description":"A ratio of the best estimated turnover to the best estimated employees. This is calculated across the SIC(s) a company belongs to.","type":"number","format":"double"},"CompanyAgeInDays":{"description":"The age of the company in days.","type":"number","format":"double"},"CompanySizeEstimate":{"description":"Company size estimate. This is a categorical value and is based on the Companies Act 2006 definition.","type":"string"},"EmploymentEstimates":{"description":"This is an array with the following fields. It is based on the employment estimates data. Financials are used to estimate the number of employees.","type":"array","items":{"$ref":"#/components/schemas/YearMeasure"}},"OECDScaleup":{"description":"Eurostat-OECD scale-up, computed from filed accounts only. The growth window ends at the latest filed accounts and starts at the most recent filed year at least three years earlier; the company needs 10 or more employees at the window start, at least four filed years with 10 or more employees inside the window, and annualised employment growth of at least 20% per year across it. BestEstimateGrowthPercentagePerYear plays no part in this flag.","type":"boolean"},"SICs":{"description":"An array of SIC codes the company belongs to.","type":"array","items":{"type":"string"}},"TurnoverEstimates":{"description":"This is an array with the following fields. It is based on the turnover estimates data. Financials are used to estimate their turnover over time.","type":"array","items":{"$ref":"#/components/schemas/YearMeasure"}}},"type":"object"},"CompanyJobPosting":{"description":"Generated from The Data City data dictionary (schema CompanyJobPosting, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"MedianSalary":{"description":"The average of the monthly median advertised salaries for this company's postings in this SOC4 occupation group, in GBP. Despite the name this is a mean of monthly medians rather than a median across individual postings. Empty where no salary was advertised. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"Postings":{"description":"The number of unique job postings this company advertised in this SOC4 occupation group. Covers the most recent five years of postings: the upstream extract is limited to that window, so this is a five-year total rather than an all-time one. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"},"SOC4Code":{"description":"The four-digit Standard Occupational Classification (SOC) code for the occupation group these postings fall into. SOC is the UK standard classification of occupations. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"SOC4Name":{"description":"The name of the occupation group identified by SOC4Code, for example 'Programmers and software development professionals'. Job postings data is a paid upgrade and is not included for all customers.","type":"string"}},"type":"object"},"CompanyJobPostingByCertificationsSkill":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingByCertificationsSkill, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"MedianPostingDuration":{"description":"Not currently populated and always empty. Reserved for the median number of days that postings requesting this certification stayed open, but the pipeline does not load a value for it. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"SkillName":{"description":"The name of a certification requested in this company's job postings, as identified by Lightcast, for example 'Certified Public Accountant'. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"UniquePostings":{"description":"The number of unique job postings from this company that requested this certification. Covers the most recent five years of postings: the upstream extract is limited to that window, so this is a five-year total rather than an all-time one. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingByCommonSkill":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingByCommonSkill, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"MedianPostingDuration":{"description":"Not currently populated and always empty. Reserved for the median number of days that postings requesting this common skill stayed open, but the pipeline does not load a value for it. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"SkillName":{"description":"The name of a common skill requested in this company's job postings, as identified by Lightcast. Common skills are general workplace skills such as communication or teamwork. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"UniquePostings":{"description":"The number of unique job postings from this company that requested this common skill. Covers the most recent five years of postings: the upstream extract is limited to that window, so this is a five-year total rather than an all-time one. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingByLOTCodeOverTime":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingByLOTCodeOverTime, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"AverageMedianSalary":{"description":"The median advertised salary Lightcast reports for this occupation in this month, in GBP. Averaged where one company number matches more than one Lightcast company record, which is where the field name comes from. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"Count":{"description":"The number of unique job postings this company advertised in this LOT occupation in this month. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"},"LOTCode":{"description":"The Lightcast Occupation Taxonomy (LOT) code this month's postings are counted against. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"Timestamp":{"description":"The month this data point covers, as Unix epoch seconds at the start of that month. The series covers the most recent five years. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingByLot":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingByLot, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"LotCode":{"description":"The Lightcast Occupation Taxonomy (LOT) code for the occupation these postings fall into. LOT is Lightcast's own occupation taxonomy, separate from the UK SOC classification used by the CompanyJobPosting schema. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"LotName":{"description":"The name of the occupation identified by LotCode. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"MedianSalary":{"description":"The average of the monthly median advertised salaries for this company's postings in this LOT occupation, in GBP. Despite the name this is a mean of monthly medians rather than a median across individual postings. Empty where no salary was advertised. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"Postings":{"description":"The number of unique job postings this company advertised in this LOT occupation. Covers the most recent five years of postings: the upstream extract is limited to that window, so this is a five-year total rather than an all-time one. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingBySOC4CodeOverTime":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingBySOC4CodeOverTime, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"AverageMedianSalary":{"description":"The median advertised salary Lightcast reports for this occupation in this month, in GBP. Averaged where one company number matches more than one Lightcast company record, which is where the field name comes from. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"Count":{"description":"The number of unique job postings this company advertised in this SOC4 occupation group in this month. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"},"SOC4Code":{"description":"The four-digit Standard Occupational Classification (SOC) code this month's postings are counted against. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"Timestamp":{"description":"The month this data point covers, as Unix epoch seconds at the start of that month. The series covers the most recent five years. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingBySoftwareSkill":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingBySoftwareSkill, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"MedianPostingDuration":{"description":"Not currently populated and always empty. Reserved for the median number of days that postings requesting this software skill stayed open, but the pipeline does not load a value for it. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"SkillName":{"description":"The name of a software skill requested in this company's job postings, as identified by Lightcast, for example 'Python' or 'Microsoft Excel'. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"UniquePostings":{"description":"The number of unique job postings from this company that requested this software skill. Covers the most recent five years of postings: the upstream extract is limited to that window, so this is a five-year total rather than an all-time one. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingBySpecializedSkill":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingBySpecializedSkill, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"MedianPostingDuration":{"description":"Not currently populated and always empty. Reserved for the median number of days that postings requesting this specialised skill stayed open, but the pipeline does not load a value for it. Job postings data is a paid upgrade and is not included for all customers.","type":"number","format":"double"},"SkillName":{"description":"The name of a specialised skill requested in this company's job postings, as identified by Lightcast. Specialised skills are specific to an occupation, as opposed to general workplace skills. Job postings data is a paid upgrade and is not included for all customers.","type":"string"},"UniquePostings":{"description":"The number of unique job postings from this company that requested this specialised skill. Covers the most recent five years of postings: the upstream extract is limited to that window, so this is a five-year total rather than an all-time one. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingOverTime":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingOverTime, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"Count":{"description":"The number of unique job postings this company advertised in this month, across all occupations in this series. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"},"Timestamp":{"description":"The month this data point covers, as Unix epoch seconds at the start of that month. The series covers the most recent five years. Job postings data is a paid upgrade and is not included for all customers.","type":"integer","format":"int32"}},"type":"object"},"CompanyJobPostingsOverTime":{"description":"Generated from The Data City data dictionary (schema CompanyJobPostingsOverTime, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CompanyJobPostingsOverTimeByLot":{"description":"Monthly totals of this company's job postings across all LOT occupations, one entry per month, covering the most recent five years. Job postings data is a paid upgrade and is not included for all customers.","type":"array","items":{"$ref":"#/components/schemas/CompanyJobPostingOverTime"}},"CompanyJobPostingsOverTimeBySoc4":{"description":"Monthly totals of this company's job postings across all SOC4 occupations, one entry per month, covering the most recent five years. Job postings data is a paid upgrade and is not included for all customers.","type":"array","items":{"$ref":"#/components/schemas/CompanyJobPostingOverTime"}}},"type":"object"},"CompanyNumberRtic":{"description":"Placeholder: referenced by the data dictionary but no standalone field list is published for this type. See https://thedatacity.github.io/data-dictionary/","type":"object"},"CompanySimilarity":{"description":"Generated from The Data City data dictionary (schema CompanySimilarity, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CompanyOne":{"description":"The company number of the first company (the company you are looking at).","type":"string"},"CompanyTwo":{"description":"The company number of the second company (the company that is similar).","type":"string"},"Similarity":{"description":"A numerical value representing the similarity between the two companies.","type":"number","format":"double"}},"type":"object"},"CompanyTrade":{"description":"Placeholder: referenced by the data dictionary but no standalone field list is published for this type. See https://thedatacity.github.io/data-dictionary/","type":"object"},"DealroomPerRoundFunding":{"description":"Generated from The Data City data dictionary (schema DealroomPerRoundFunding, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CompanyId":{"description":"The investment provider's identifier for the company.","type":"string"},"LastInvestmentDate":{"description":"The last investment date.","type":"string","format":"date-time"},"ParticipatingInvestorTypes":{"description":"The distinct Investor types of the round's participating investors (for example 'Angel', 'Venture Capital'), ' | '-joined and alphabetical. Empty on acquisition and IPO rows, and where no participating investor has a type.","type":"string"},"ProviderCompanyName":{"description":"The investment provider's name for the company.","type":"string"},"RoundAmount_GBP_Million":{"description":"The round amount, in GBP millions.","type":"number","format":"double"},"RoundDate":{"description":"The round date.","type":"string","format":"date-time"},"RoundInvestorName":{"description":"The round investor name.","type":"string"},"RoundInvestorType":{"description":"Deprecated and always empty. The funding source no longer supplies an investor type per round; use ParticipatingInvestorTypes for the types of investor that took part in a round.","type":"string"},"RoundLeadInvestorName":{"description":"The lead investor name(s) for the round, ' | '-joined and always a subset of RoundInvestorName. Empty when the provider flags no lead.","type":"string"},"RoundType":{"description":"The round type.","type":"string"},"RoundVerified":{"description":"A boolean. 1 if the round is verified by the investment provider.","type":"integer","format":"int32"},"Spinout":{"description":"Deprecated and always 0. The funding source no longer flags spinouts per round; spinout status is now a company-level field populated from the spinout register.","type":"integer","format":"int32"},"TotalInvestmentRaised_GBP_Million":{"description":"The total investment the company has raised. DEBT and ACQUISITION rounds are not included in this total.","type":"number","format":"double"}},"type":"object"},"DistinctBrandInfo":{"description":"Placeholder: referenced by the data dictionary but no standalone field list is published for this type. See https://thedatacity.github.io/data-dictionary/","type":"object"},"ESGStatementAnchor":{"description":"Generated from The Data City data dictionary (schema ESGStatementAnchor, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"Anchor":{"description":"The ESG statement anchor.","type":"string"},"Domain":{"description":"The domain of the company's website.","type":"string"},"Word":{"description":"The word in the ESG statement anchor which indicates the type of ESG statement.","type":"string"}},"type":"object"},"GroupStructureDetails":{"description":"Generated from The Data City data dictionary (schema GroupStructureDetails, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CanBeConsolidated":{"description":"Indicates whether the subsidiary company can be consolidated into the parent company's financial statements.","type":"boolean"},"ConsolidatedAccountsCompanyName":{"description":"The name of the company whose accounts are consolidated with the subsidiary. There can be multiple consolidated accounts company names if the subsidiary's accounts are consolidated with more than one other company.","type":"string"},"ConsolidatedAccountsCompanyNumber":{"description":"The Company Number of the company whose accounts are consolidated with the subsidiary. There can be multiple consolidated accounts company numbers if the subsidiary's accounts are consolidated with more than one other company.","type":"string"},"IsLikelyDistinctBrand":{"description":"Indicates whether the subsidiary is likely to be a distinct brand within the parent company's group structure.","type":"boolean"},"IsSubGroup":{"description":"Indicates whether the subsidiary is part of a sub-group within the parent company's group structure.","type":"boolean"},"ParentCompanyName":{"description":"The name of the parent company directly above the subsidiary in the group structure.","type":"string"},"ParentCompanyNumber":{"description":"The Company Number of the parent company directly above the subsidiary in the group structure.","type":"string"},"SubsidiaryCompanyLevel":{"description":"The level at which the subsidiary company operates within the group structure. Level 0 is the ultimate parent company.","type":"integer","format":"int32"},"SubsidiaryCompanyName":{"description":"The name of the subsidiary company.","type":"string"},"SubsidiaryCompanyNumber":{"description":"The Company Number of the subsidiary.","type":"string"},"SubsidiaryCompanyWebsite":{"description":"The website of the subsidiary company.","type":"string"},"TypeOfAccounts":{"description":"The type of accounts filed by the subsidiary company, which can indicate its financial reporting requirements and potential consolidation status.","type":"string"},"UltimateParentCompanyName":{"description":"The name of the ultimate parent company in the group structure.","type":"string"},"UltimateParentCompanyNumber":{"description":"The Company Number of the ultimate parent company in the group structure.","type":"string"}},"type":"object"},"IndustrialStrategySector":{"description":"Generated from The Data City data dictionary (schema IndustrialStrategySector, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"ISCode":{"description":"Industrial Strategy Sector codes assigned to the company. These codes are based on the UK Government's Industrial Strategy framework, but created by The Data City.","type":"string"},"ISCodeName":{"description":"Industrial Strategy Sectors assigned to the company. These names correspond to the Industrial Strategy Sectors based on the UK Government's Industrial Strategy framework.","type":"string"},"ISVerticalCode":{"description":"Industrial Strategy Vertical codes assigned to the company. These codes are sub-codes within the main Industrial Strategy Sector codes, providing a more granular classification of the company's business activities. The sub-codes correspond to the frontier industries identified by the government.","type":"string"},"ISVerticalName":{"description":"Industrial Strategy Verticals assigned to the company. These names correspond to the vertical sub-categories within the Industrial Strategy Sectors, providing detailed insight into the company's specific area of operation. The sub-codes correspond to the frontier industries identified by the government.","type":"string"}},"type":"object"},"InnovateUKFundingClean":{"description":"Generated from The Data City data dictionary (schema InnovateUKFundingClean, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"ActualSpendtoDate":{"description":"The actual spend to date.","type":"number","format":"double"},"ApplicationNumber":{"description":"The application number.","type":"string"},"AwardOffered":{"description":"The value of the award.","type":"number","format":"double"},"CompetitionReference":{"description":"The competition reference.","type":"string"},"CompetitionTitle":{"description":"The competition title.","type":"string"},"CompetitionYear":{"description":"The competition year.","type":"integer","format":"int32"},"EnterpriseSize":{"description":"The size of the company.","type":"string"},"IndustrialStrategyChallengeFundISCF":{"description":"A boolean. 'Yes' if the project is part of the Industrial Strategy Challenge Fund.","type":"string"},"InnovateUKProductType":{"description":"The product type of the project.","type":"string"},"IsLeadParticipant":{"description":"A boolean. 'Yes' if the participant is the lead participant.","type":"string"},"ParticipantName":{"description":"The participant name (usually the company name).","type":"string"},"ParticipantWithdrawnFromProject":{"description":"A boolean. 'Active' if the participant is still active in the project.","type":"string"},"Postcode":{"description":"The postcode of the project.","type":"string"},"ProgrammeTitle":{"description":"The programme title.","type":"string"},"ProjectEndDate":{"description":"The project end date.","type":"string","format":"date-time"},"ProjectNumber":{"description":"The project number.","type":"string"},"ProjectStartDate":{"description":"The project start date.","type":"string","format":"date-time"},"ProjectStatus":{"description":"The status of the project.","type":"string"},"ProjectTitle":{"description":"The project title.","type":"string"},"PublicDescription":{"description":"The public description of the project.","type":"string"},"Sector":{"description":"The sector of the project.","type":"string"},"TotalCosts":{"description":"The total costs of the project.","type":"number","format":"double"}},"type":"object"},"ListInsights":{"description":"Generated from The Data City data dictionary (schema ListInsights, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"BestEstimateTotalEmployeesAttributedToLocation":{"description":"Sum of best-estimate employees across operating locations that match the active geographic filter (e.g. selected areas, postcode search and radius, or custom geography WKT). Null when no geographic filter applies or when no locations match the filter.","type":"integer","format":"int64"},"BestEstimateTotalGVAAttributedToLocation":{"description":"Sum of best-estimate GVA across operating locations that match the active geographic filter (e.g. selected areas, postcode search and radius, or custom geography WKT). Null when no geographic filter applies or when no locations match the filter.","type":"number","format":"double"},"BestEstimateTotalTurnoverAttributedToLocation":{"description":"Sum of best-estimate turnover across operating locations that match the active geographic filter (e.g. selected areas, postcode search and radius, or custom geography WKT). Null when no geographic filter applies or when no locations match the filter.","type":"number","format":"double"},"TopInvestorsByRoundCount":{"description":"The investors that have participated in the most funding rounds across companies in this list, ranked by number of rounds.","type":"array","items":{"$ref":"#/components/schemas/Topinvestor"}},"TopInvestorsByValue":{"description":"The investors that have contributed the most total funding value across companies in this list, ranked by total investment amount in GBP.","type":"array","items":{"$ref":"#/components/schemas/Topinvestor"}}},"type":"object"},"Officer":{"description":"Generated from The Data City data dictionary (schema Officer, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"AddressLine1":{"description":"The first line of the address of the officer.","type":"string"},"AddressLine2":{"description":"The second line of the address of the officer.","type":"string"},"Appointedon":{"description":"The date the officer was appointed.","type":"string","format":"date"},"Careof":{"description":"The care of the officer.","type":"string"},"Country":{"description":"The country of the officer.","type":"string"},"County":{"description":"The county of the officer.","type":"string"},"DOB":{"description":"The date of birth of the officer.","type":"string","format":"date"},"Forenames":{"description":"The forenames of the officer.","type":"string"},"Honours":{"description":"The honours of the officer.","type":"string"},"Nationality":{"description":"The nationality of the officer.","type":"string"},"Occupation":{"description":"The occupation of the officer.","type":"string"},"PersonNumber":{"description":"The person number of the officer. Person number is a unique identifier for the officer provided by Companies House.","type":"string"},"PostTown":{"description":"The post town of the officer.","type":"string"},"ResignationDate":{"description":"The date the officer resigned (if applicable).","type":"string","format":"date"},"Role":{"description":"The role of the officer.","type":"string"},"Surname":{"description":"The surname of the officer.","type":"string"},"Title":{"description":"The title of the officer.","type":"string"},"UsualResidentialCountry":{"description":"The usual residential country of the officer.","type":"string"}},"type":"object"},"PerRoundFunding":{"description":"Generated from The Data City data dictionary (schema PerRoundFunding, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CompanyId":{"description":"The investment provider's identifier for the company.","type":"string"},"LastInvestmentDate":{"description":"The last investment date.","type":"string","format":"date-time"},"ParticipatingInvestorTypes":{"description":"The distinct Investor types of the round's participating investors (for example 'Angel', 'Venture Capital'), ' | '-joined and alphabetical. Empty on acquisition and IPO rows, and where no participating investor has a type.","type":"string"},"ProviderCompanyName":{"description":"The investment provider's name for the company.","type":"string"},"RoundAmount_GBP_Million":{"description":"The round amount, in GBP millions.","type":"number","format":"double"},"RoundDate":{"description":"The round date.","type":"string","format":"date-time"},"RoundInvestorName":{"description":"The round investor name.","type":"string"},"RoundInvestorType":{"description":"Deprecated and always empty. The funding source no longer supplies an investor type per round; use ParticipatingInvestorTypes for the types of investor that took part in a round.","type":"string"},"RoundLeadInvestorName":{"description":"The lead investor name(s) for the round, ' | '-joined and always a subset of RoundInvestorName. Empty when the provider flags no lead.","type":"string"},"RoundType":{"description":"The round type.","type":"string"},"RoundVerified":{"description":"A boolean. 1 if the round is verified by the investment provider.","type":"integer","format":"int32"},"Spinout":{"description":"Deprecated and always 0. The funding source no longer flags spinouts per round; spinout status is now a company-level field populated from the spinout register.","type":"integer","format":"int32"},"TotalInvestmentRaised_GBP_Million":{"description":"The total investment the company has raised. DEBT and ACQUISITION rounds are not included in this total.","type":"number","format":"double"}},"type":"object"},"PerRoundInvestment":{"description":"Generated from The Data City data dictionary (schema PerRoundInvestment, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CompanyId":{"description":"The investment provider's identifier for the company.","type":"string"},"LastInvestmentDate":{"description":"The last investment date.","type":"string","format":"date-time"},"ParticipatingInvestorTypes":{"description":"The distinct Investor types of the round's participating investors (for example 'Angel', 'Venture Capital'), ' | '-joined and alphabetical. Empty on acquisition and IPO rows, and where no participating investor has a type.","type":"string"},"ProviderCompanyName":{"description":"The investment provider's name for the company.","type":"string"},"RoundAmount_GBP_Million":{"description":"The round amount, in GBP millions.","type":"number","format":"double"},"RoundDate":{"description":"The round date.","type":"string","format":"date-time"},"RoundInvestorName":{"description":"The round investor name.","type":"string"},"RoundInvestorType":{"description":"Deprecated and always empty. The funding source no longer supplies an investor type per round; use ParticipatingInvestorTypes for the types of investor that took part in a round.","type":"string"},"RoundLeadInvestorName":{"description":"The lead investor name(s) for the round, ' | '-joined and always a subset of RoundInvestorName. Empty when the provider flags no lead.","type":"string"},"RoundType":{"description":"The round type.","type":"string"},"RoundVerified":{"description":"A boolean. 1 if the round is verified by the investment provider.","type":"integer","format":"int32"},"Spinout":{"description":"Deprecated and always 0. The funding source no longer flags spinouts per round; spinout status is now a company-level field populated from the spinout register.","type":"integer","format":"int32"},"TotalInvestmentRaised_GBP_Million":{"description":"The total investment the company has raised. DEBT and ACQUISITION rounds are not included in this total.","type":"number","format":"double"}},"type":"object"},"PersonWithSignificantControl":{"description":"Generated from The Data City data dictionary (schema PersonWithSignificantControl, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CountryOfResidence":{"description":"The country of residence of the person.","type":"string"},"DoB":{"description":"The date of birth of the person.","type":"string"},"Name":{"description":"The name of the person.","type":"string"},"NatureOfControl":{"description":"The nature of the person's control.","type":"string"},"Title":{"description":"The title of the person.","type":"string"},"Type":{"description":"The type of the person's control.","type":"string"}},"type":"object"},"PostcodeDetail_grouped":{"description":"Generated from The Data City data dictionary (schema PostcodeDetail_grouped, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"AssociatedAddress":{"description":"The associated address found with the postcode.","type":"string"},"BestEstimateLocationEmployees":{"description":"The best estimate of employees for this location.","type":"integer","format":"int64"},"BestEstimateLocationGVA":{"description":"The best estimate of GVA attributed to this operating location.","type":"number","format":"double"},"BestEstimateLocationTurnover":{"description":"The best estimate of turnover for this location.","type":"number","format":"double"},"FoundOnWebpage":{"description":"A boolean value to indicate if the postcode was found on the company's website.","type":"boolean"},"ITL1":{"description":"The ITL1 region code the postcode resides in.","type":"string"},"ITL1NM":{"description":"The ITL1 region name the postcode resides in.","type":"string"},"ITL2":{"description":"The ITL2 (International Territorial Level 2) region code the postcode resides in.","type":"string"},"ITL2NM":{"description":"The ITL2 (International Territorial Level 2) region name the postcode resides in.","type":"string"},"ITL3":{"description":"The ITL3 (International Territorial Level 3) region code the postcode resides in.","type":"string"},"IsBlacklisted":{"description":"A boolean value to indicate if the postcode is blacklisted as an operating address.","type":"boolean"},"IsOperatingAddress":{"description":"A boolean value to indicate if this postcode is an operating address for the company.","type":"boolean"},"IsSubsidiaryAddress":{"description":"A boolean value to indicate if this postcode is a subsidiary's address rather than the company's own.","type":"boolean"},"LAcode":{"description":"The local authority code the postcode resides in.","type":"string"},"LAname":{"description":"The local authority name the postcode resides in.","type":"string"},"LSOA":{"description":"The Lower Layer Super Output Area the postcode resides in.","type":"string"},"Latitude":{"description":"The latitude of the location.","type":"number","format":"double"},"Longitude":{"description":"The longitude of the location.","type":"number","format":"double"},"MSOA":{"description":"The Middle Layer Super Output Area the postcode resides in.","type":"string"},"OECDFUACorePlusCommuting":{"description":"The OECD Economic Classification Data - Functional Urban Area Core Plus Commuting code the postcode resides in.","type":"string"},"Postcode":{"description":"A postcode for the company.","type":"string"},"Postcode_withspaces":{"description":"A postcode for the company with formatted spaces.","type":"string"},"RegisteredPostcode":{"description":"A boolean value to indicate if the postcode is the registered postcode.","type":"boolean"},"StrategicAuthorityCode":{"description":"The strategic authority code the postcode resides in.","type":"string"},"StrategicAuthorityName":{"description":"The strategic authority name the postcode resides in.","type":"string"},"UKConstituency":{"description":"The constituency name the postcode resides in. The constituencies filter is comprised of UK parliamentary constituencies.","type":"string"}},"type":"object"},"RSIC":{"description":"Generated from The Data City data dictionary (schema RSIC, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"SIC_Code":{"description":"The SIC code of the RSIC.","type":"string"},"Score":{"description":"The score of the RSIC.","type":"number","format":"double"}},"type":"object"},"ShareHolder":{"description":"Generated from The Data City data dictionary (schema ShareHolder, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"CURRENCY":{"description":"The currency of the share.","type":"string"},"SHARE_HOLDER_NAME":{"description":"The name of the shareholder.","type":"string"},"SHARE_HOLDING":{"description":"The holding of the share as a value.","type":"number","format":"double"},"SHARE_PERCENT":{"description":"The percentage of the share.","type":"number","format":"double"},"SHARE_TYPE":{"description":"The type of the share.","type":"string"},"TOTAL_SHARES":{"description":"The total number of shares.","type":"number","format":"double"},"TOTAL_SHARE_VALUE":{"description":"The total value of the shares.","type":"number","format":"double"}},"type":"object"},"Topinvestor":{"description":"Placeholder: referenced by the data dictionary but no standalone field list is published for this type. See https://thedatacity.github.io/data-dictionary/","type":"object"},"UrlMatchStat":{"description":"Generated from The Data City data dictionary (schema UrlMatchStat, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"MatchedWebsite":{"description":"The matched website.","type":"string"},"MatchedWebsiteConfidence":{"description":"The confidence level of the website match.","type":"string"},"MatchedWebsiteReasoning":{"description":"An array of reasons for the match.","type":"array","items":{"type":"string"}},"MatchedWebsiteScore":{"description":"The matched website score. The higher the score the more confident we are that the website is a match.","type":"number","format":"double"}},"type":"object"},"WomanLedStats":{"description":"Generated from The Data City data dictionary (schema WomanLedStats, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"ActiveFemaleDirectors":{"description":"The number of active female directors.","type":"integer","format":"int32"},"ActiveFemaleFounders":{"description":"The number of female founders that are still active at the company.","type":"integer","format":"int32"},"ActiveMaleDirectors":{"description":"The number of active male directors.","type":"integer","format":"int32"},"ActiveMaleFounders":{"description":"The number of male founders that are still active at the company.","type":"integer","format":"int32"},"InitialFemaleFounders":{"description":"The number of female founders at the time of founding.","type":"integer","format":"int32"},"InitialMaleFounders":{"description":"The number of male founders at the time of founding.","type":"integer","format":"int32"},"TotalActiveDirectors":{"description":"The number of active total directors.","type":"integer","format":"int32"},"TotalActiveFounders":{"description":"The number of founders that are still active at the company.","type":"integer","format":"int32"},"TotalInitialFounders":{"description":"The number of founders at the time of founding.","type":"integer","format":"int32"}},"type":"object"},"YearMeasure":{"description":"Generated from The Data City data dictionary (schema YearMeasure, version 1.0). See https://thedatacity.github.io/data-dictionary/","properties":{"Estimated":{"description":"The estimated number of employees (for EmploymentEstimates) or estimated turnover (for TurnoverEstimates).","type":"integer","format":"int64"},"Measure":{"description":"The measured number of employees (for EmploymentEstimates) or measured turnover (for TurnoverEstimates).","type":"integer","format":"int64"},"Year":{"description":"The financial year.","type":"integer","format":"int32"}},"type":"object"},"PostCheckCompanyNumbersBody":{"title":"Check companies exist","description":"Full shape is under Schema; example is minimal.","required":["companyNumbers"],"properties":{"companyNumbers":{"description":"JSON body for POST companies check.","type":"array","items":{"type":"string"}}},"type":"object","example":{"companyNumbers":["10958787"]}},"PostClassifyCompaniesBody":{"title":"Classify companies","description":"Full shape is under Schema; example is minimal.","required":["yes","no"],"properties":{"yes":{"description":"Company numbers to include.","type":"array","items":{"type":"string"}},"no":{"description":"Company numbers to exclude.","type":"array","items":{"type":"string"}},"returnCount":{"type":"integer"}},"type":"object","example":{"yes":["10958787"],"no":["10958788"],"returnCount":20}},"PostExplainClassifierBody":{"title":"Explain classifier (POST)","description":"Full shape is under Schema; example is minimal.","required":["yes","no"],"properties":{"yes":{"description":"Company numbers to include (positive class).","type":"array","items":{"type":"string"}},"no":{"description":"Company numbers to exclude (negative class).","type":"array","items":{"type":"string"}}},"type":"object","example":{"yes":["10958787"],"no":["10958788"]}},"PostFilteredCompaniesFilterExtensionBody":{"title":"Filtered companies \u2014 upstream filter body","properties":{"PreFilter":{"description":"Nested FiltersInPostRequestBody payload.","type":"object"},"PreFilterType":{"description":"Product API pre-filter selector (upstream-defined).","type":"string"},"IncorporationDateFrom":{"type":"string","format":"date","nullable":true},"IncorporationDateTo":{"type":"string","format":"date","nullable":true},"Yes":{"description":"Company numbers to explicitly include (upstream Yes list).","type":"array","items":{"type":"string"}},"No":{"description":"Company numbers to explicitly exclude (upstream No list).","type":"array","items":{"type":"string"}},"InsightsFlag":{"type":"boolean","nullable":true},"CustomGeographyGeoJSON":{"type":"string"},"CustomGeographyWKT":{"type":"string"},"ReturnCompanyIDsOnly":{"type":"boolean"},"ReturnBasicCompanyDetailsOnly":{"type":"boolean"},"NumberOfFolds":{"description":"Number of cross-validation or sampling folds for upstream analysis workflows.","type":"integer"},"AllWomenLedDirected":{"description":"Gender-leadership filters: one boolean per mutually-exclusive category, for directors (\u2026Directed) and founders (\u2026Founded). Ticking several within an axis is a union (OR); the two axes combine with AND. Replaces the pre-2026 overlapping flags (WomenLed, MenLedIncludingMixed, etc.), which are no longer accepted.","type":"boolean"},"MajorityWomenLedDirected":{"type":"boolean"},"MixedLedDirected":{"type":"boolean"},"MajorityMenLedDirected":{"type":"boolean"},"AllMenLedDirected":{"type":"boolean"},"UncertainDirected":{"type":"boolean"},"AllWomenLedFounded":{"type":"boolean"},"MajorityWomenLedFounded":{"type":"boolean"},"MixedLedFounded":{"type":"boolean"},"MajorityMenLedFounded":{"type":"boolean"},"AllMenLedFounded":{"type":"boolean"},"UncertainFounded":{"type":"boolean"},"HasExported":{"type":"boolean"},"HasImported":{"type":"boolean"},"MaxGrowthRate":{"type":"number","nullable":true},"MinGrowthRate":{"type":"number","nullable":true},"ManuallyInclude":{"type":"array","items":{"type":"string"}},"ManuallyExclude":{"type":"array","items":{"type":"string"}},"ExploreManuallyInclude":{"type":"array","items":{"type":"string"}},"ExploreManuallyExclude":{"type":"array","items":{"type":"string"}},"FieldEditsSource":{"type":"array","items":{"type":"string"}},"MinInvestment":{"description":"Minimum total investment, same currency/units as upstream.","type":"number","nullable":true},"MaxInvestment":{"description":"Maximum total investment, same currency/units as upstream.","type":"number","nullable":true},"IncludeUnknownInvestment":{"description":"Whether to include companies with no investment amount.","type":"boolean","nullable":true},"InvestmentRoundType":{"description":"Investment round types to match.","type":"array","items":{"type":"string"}},"InvestmentRoundDateFrom":{"type":"string","format":"date-time","nullable":true},"InvestmentRoundDateTo":{"type":"string","format":"date-time","nullable":true},"InvestmentLatestRoundType":{"type":"boolean","nullable":true},"MinDealroom":{"description":"Obsolete alias for `MinInvestment`.","type":"number","nullable":true,"deprecated":true},"MaxDealroom":{"description":"Obsolete alias for `MaxInvestment`.","type":"number","nullable":true,"deprecated":true},"IncludeUnknownDealroom":{"description":"Obsolete alias for `IncludeUnknownInvestment`.","type":"boolean","nullable":true,"deprecated":true},"DealroomRoundType":{"description":"Obsolete alias for `InvestmentRoundType`.","type":"array","items":{"type":"string"},"deprecated":true},"DealroomRoundDateFrom":{"description":"Obsolete alias for `InvestmentRoundDateFrom`.","type":"string","format":"date-time","nullable":true,"deprecated":true},"DealroomRoundDateTo":{"description":"Obsolete alias for `InvestmentRoundDateTo`.","type":"string","format":"date-time","nullable":true,"deprecated":true},"DealroomLatestRoundType":{"description":"Obsolete alias for `InvestmentLatestRoundType`.","type":"boolean","nullable":true,"deprecated":true},"ExcludeOutliers":{"type":"boolean","nullable":true},"RemoveSubsidiaryCompanies":{"type":"boolean","nullable":true},"CompanyStatus":{"type":"string"},"CompanyStatusList":{"type":"array","items":{"type":"string"}},"ViewOutliers":{"type":"boolean","nullable":true},"ExcludeForeignCompanies":{"type":"boolean","nullable":true},"OECDScaleup":{"type":"boolean","nullable":true},"IsSpinOut":{"type":"boolean","nullable":true},"HasLightcastData":{"type":"boolean","nullable":true},"HasProfilesData":{"type":"boolean","nullable":true},"SelectedLOTCodes":{"description":"Lightcast LOT (level of title) occupation codes.","type":"array","items":{"type":"string"}},"SelectedSOCCodes":{"description":"SOC (Standard Occupational Classification) codes for job postings filter.","type":"array","items":{"type":"string"}},"JobPostingsFromDate":{"type":"string","format":"date-time","nullable":true},"JobPostingsToDate":{"type":"string","format":"date-time","nullable":true},"ReturnCount":{"description":"Consumed by this API gateway; not forwarded as part of the filter object.","type":"integer","nullable":true},"Skip":{"description":"Pagination offset (number of rows to skip).","type":"integer"},"Cutoff":{"description":"Score or relevance threshold for ranked or similarity results (upstream-defined scale).","type":"number","nullable":true},"ContainsKeyword":{"type":"string"},"DoesNotContainKeyword":{"type":"string"},"CompanyName":{"type":"string"},"OrderBy":{"type":"string"},"Order":{"type":"string"},"DownloadFormat":{"type":"string"},"DownloadFields":{"type":"array","items":{"type":"string"}},"OnlyCompaniesWithWebsites":{"type":"boolean"},"OnlyCompaniesWithRegisteredAddressWithinFilterLocation":{"type":"boolean"},"OnlyCompaniesWithoutRegisteredAddressWithinFilterLocation":{"type":"boolean"},"CalculateInsightsBasedOnlyOnRegisteredAddresses":{"type":"boolean"},"UserCICs":{"description":"Same as JSON `cics` when sent via this gateway.","type":"array","items":{"type":"string"}},"SelectedRTICs":{"description":"Same as JSON `rtics` when sent via this gateway.","type":"array","items":{"type":"string"}},"SelectedSICs":{"description":"UK SIC 2007 industry codes.","type":"array","items":{"type":"string"}},"SelectedRSICs":{"description":"RSIC (Real-Time SIC) codes: UK SIC codes that correct, replace or fill missing Companies House SICs.","type":"array","items":{"type":"string"}},"SelectedISCodes":{"description":"Industry Standard (IS) classification codes used by the product.","type":"array","items":{"type":"string"}},"SelectedExportCodes":{"type":"array","items":{"type":"string"}},"TradeFromDate":{"type":"string","format":"date-time","nullable":true},"TradeToDate":{"type":"string","format":"date-time","nullable":true},"SelectedImportCodes":{"type":"array","items":{"type":"string"}},"SelectedSICHLUs":{"description":"SIC high-level unit or grouping codes (aggregated SIC bands).","type":"array","items":{"type":"string"}},"SelectedCategories":{"type":"array","items":{"type":"string"}},"SelectedCities":{"type":"array","items":{"type":"string"}},"SelectedLANames":{"type":"array","items":{"type":"string"}},"SelectedLACodes":{"type":"array","items":{"type":"string"}},"SelectedCountriesOfOrigin":{"type":"array","items":{"type":"string"}},"SelectedITL1Regions":{"description":"UK ITL1 (international territorial level 1) region codes.","type":"array","items":{"type":"string"}},"SelectedITL2Regions":{"description":"UK ITL2 sub-region codes.","type":"array","items":{"type":"string"}},"SelectedUKConstituencies":{"type":"array","items":{"type":"string"}},"SelectedUltimateParentNations":{"type":"array","items":{"type":"string"}},"SelectedStrategicAuthorityCodes":{"type":"array","items":{"type":"string"}},"SelectedStrategicAuthorityNames":{"type":"array","items":{"type":"string"}},"SelectedCompanySizes":{"type":"array","items":{"type":"string"}},"SelectedWebsiteMatchConfidence":{"type":"integer","nullable":true},"NotKnownToBeForeign":{"type":"boolean","nullable":true},"KnownToBeForeign":{"type":"boolean","nullable":true},"ESTEMPLOYEES_MAX":{"description":"Maximum estimated employee count (modeled estimate, not only filed headcount).","type":"integer","format":"int64","nullable":true},"ESTEMPLOYEES_MIN":{"description":"Minimum estimated employee count (modeled estimate).","type":"integer","format":"int64","nullable":true},"ESTTURNOVER_MAX":{"description":"Maximum estimated turnover (modeled estimate).","type":"integer","format":"int64","nullable":true},"ESTTURNOVER_MIN":{"description":"Minimum estimated turnover (modeled estimate).","type":"integer","format":"int64","nullable":true},"EMPLOYEES_MIN":{"description":"Minimum employees from filed or normalised accounts.","type":"integer","format":"int64","nullable":true},"EMPLOYEES_MAX":{"description":"Maximum employees from filed or normalised accounts.","type":"integer","format":"int64","nullable":true},"TURN_MIN":{"description":"Minimum turnover (TURN): revenue / sales per filed accounts.","type":"integer","format":"int64","nullable":true},"TURN_MAX":{"description":"Maximum turnover (TURN): revenue / sales per filed accounts.","type":"integer","format":"int64","nullable":true},"PTP_MIN":{"description":"Minimum profit before tax (pre-tax profit) from filed accounts. Same currency/units as upstream.","type":"integer","format":"int64","nullable":true},"PTP_MAX":{"description":"Maximum profit before tax (pre-tax profit) from filed accounts.","type":"integer","format":"int64","nullable":true},"PAT_MIN":{"description":"Minimum profit after tax from filed accounts.","type":"integer","format":"int64","nullable":true},"PAT_MAX":{"description":"Maximum profit after tax from filed accounts.","type":"integer","format":"int64","nullable":true},"CASH_MIN":{"description":"Minimum cash or cash-like balance sheet line (filed accounts).","type":"integer","format":"int64","nullable":true},"CASH_MAX":{"description":"Maximum cash or cash-like balance sheet line (filed accounts).","type":"integer","format":"int64","nullable":true},"TCA_MIN":{"description":"Minimum total current assets (TCA).","type":"integer","format":"int64","nullable":true},"TCA_MAX":{"description":"Maximum total current assets (TCA).","type":"integer","format":"int64","nullable":true},"TA_MIN":{"description":"Minimum total assets (TA).","type":"integer","format":"int64","nullable":true},"TA_MAX":{"description":"Maximum total assets (TA).","type":"integer","format":"int64","nullable":true},"TL_MIN":{"description":"Minimum total liabilities (TL).","type":"integer","format":"int64","nullable":true},"TL_MAX":{"description":"Maximum total liabilities (TL).","type":"integer","format":"int64","nullable":true},"SF_MIN":{"description":"Minimum shareholders funds / equity (SF).","type":"integer","format":"int64","nullable":true},"SF_MAX":{"description":"Maximum shareholders funds / equity (SF).","type":"integer","format":"int64","nullable":true},"NA_MIN":{"description":"Minimum net assets (NA).","type":"integer","format":"int64","nullable":true},"NA_MAX":{"description":"Maximum net assets (NA).","type":"integer","format":"int64","nullable":true},"NW_MIN":{"description":"Minimum net worth (NW), as defined in upstream normalised accounts.","type":"integer","format":"int64","nullable":true},"NW_MAX":{"description":"Maximum net worth (NW), as defined in upstream normalised accounts.","type":"integer","format":"int64","nullable":true},"EXPORT_MIN":{"description":"Minimum export value (trade statistics field; units per upstream).","type":"integer","format":"int64","nullable":true},"EXPORT_MAX":{"description":"Maximum export value (trade statistics field; units per upstream).","type":"integer","format":"int64","nullable":true},"EBITDA_MIN":{"description":"Minimum EBITDA where available in upstream financials.","type":"number","nullable":true},"EBITDA_MAX":{"description":"Maximum EBITDA where available in upstream financials.","type":"number","nullable":true},"Innovation_MIN":{"description":"Minimum innovation score or index (product-specific metric).","type":"number","nullable":true},"InnovateUKFunding_MIN":{"description":"Minimum total Innovate UK grant funding (or equivalent normalised amount).","type":"number","nullable":true},"InnovateUKFunding_MAX":{"description":"Maximum total Innovate UK grant funding (or equivalent normalised amount).","type":"number","nullable":true},"OnlyManufacturingCompanies":{"type":"boolean"},"OnlyESGCompanies":{"type":"boolean"},"IsLikelyDistinctBrand":{"type":"boolean","nullable":true},"SearchPostcode":{"type":"string"},"SearchPostcodeRadius":{"type":"integer","nullable":true},"SelectedPostcodeOutcodes":{"type":"array","items":{"type":"string"}},"InstantSearchString":{"type":"string"},"MinPoints":{"type":"integer"},"MinClusterSize":{"type":"integer"},"ClusterCount":{"type":"integer"},"OutlierPercentage":{"type":"integer"},"ClusteringMethod":{"type":"string"},"TrimClustersBelowPercentage":{"type":"string"},"ChangelogStartDate":{"type":"string","format":"date-time","nullable":true},"UseSemanticSearch":{"type":"boolean","nullable":true},"RTICsToExclude":{"type":"array","items":{"type":"string"}},"IS8CodesToExclude":{"description":"Industry Standard codes (IS-8 scheme) to exclude from results.","type":"array","items":{"type":"string"}}},"type":"object"},"PostFilteredCompaniesRequestBody":{"title":"POST filtered companies","description":"Composed of shared filter criteria plus extended filter fields. Query parameter `insights` is documented on each operation. Full field list is under Schema; this example is intentionally minimal.","example":{"returnCount":20},"allOf":[{"$ref":"#/components/schemas/PostFiltersCriteriaBody"},{"$ref":"#/components/schemas/PostFilteredCompaniesFilterExtensionBody"}]},"PostFiltersCriteriaBody":{"title":"POST filters criteria","description":"Optional criteria. Full field list is under Schema (Example Value may be auto-generated).","properties":{"rtics":{"description":"Selected RTIC codes.","type":"array","items":{"type":"string"}},"cics":{"description":"User CIC codes.","type":"array","items":{"type":"string"}},"CompanyNumbers":{"description":"Inline company numbers (typically up to ~50k). Use a low `returnCount` for huge portfolios so the JSON response stays small \u2014 with `?insights=true`, `insights` still aggregates the full matched set.","type":"array","items":{"type":"string"}},"CompanyNumberSetId":{"description":"Use instead of `CompanyNumbers` when the list is too large to send inline (roughly >50k) \u2014 upload via POST /v2/company-number-sets first.","type":"string"},"AllowLargeAnalysis":{"description":"Required when using a large uploaded company number set.","type":"boolean"}},"type":"object"},"PostLegacyDownloadListBody":{"title":"POST /companies/downloadList (deprecated)","description":"Full shape is under Schema; example is minimal.","properties":{"OrderBy":{"description":"Allowed: asc, desc.","type":"string"},"Order":{"type":"string"},"DownloadDetail":{"type":"string"},"DownloadFormat":{"description":"Allowed: csv, xslx, xls.","type":"string"},"CompanyNumbers":{"type":"array","items":{"type":"string"}},"ContainsKeyword":{"type":"string"},"DoesNotContainsKeyword":{"type":"string"},"ReturnCount":{"type":"integer"}},"type":"object","example":{"CompanyNumbers":["10958787"],"ReturnCount":20}},"PostListSummaryBody":{"title":"List summary (POST)","description":"Full shape is under Schema; example is minimal.","required":["companyNumbers","containsKeyword","doesNotContainsKeyword"],"properties":{"companyNumbers":{"description":"JSON body for POST list-summary (v2 and legacy rtics path).","type":"array","items":{"type":"string"}},"containsKeyword":{"type":"string"},"doesNotContainsKeyword":{"type":"string"},"returnCount":{"type":"integer"}},"type":"object","example":{"companyNumbers":["10958787"],"containsKeyword":"","doesNotContainsKeyword":"","returnCount":20}},"PostV2CompaniesBatchArrayBody":{"description":"Plain JSON array of company numbers (max 1000 per request).","type":"array","items":{"type":"string"},"example":["10958787"],"maxItems":1000},"PostV2CompaniesExportBody":{"title":"POST /v2/companies/export","description":"Full shape is under Schema; example is minimal.","properties":{"orderBy":{"description":"JSON body for POST /v2/companies/export.","type":"string"},"order":{"type":"string"},"downloadDetail":{"type":"string"},"downloadFormat":{"type":"string"},"companyNumbers":{"type":"array","items":{"type":"string"}},"containsKeyword":{"type":"string"},"doesNotContainsKeyword":{"type":"string"},"returnCount":{"type":"integer"}},"type":"object","example":{"companyNumbers":["10958787"],"returnCount":20}},"V2CompaniesByWebsiteBatchPostBody":{"title":"POST /v2/companies/by-website/batch","description":"Full shape is under Schema; example is minimal.","required":["urls"],"properties":{"urls":{"description":"Website URLs to match (union of results).","type":"array","items":{"type":"string","maxLength":8192},"minItems":1},"skip":{"description":"Number of results to skip (pagination).","type":"integer","minimum":0},"returnCount":{"description":"Page size. Omit to use the API default.","type":"integer","nullable":true,"maximum":10000,"minimum":1}},"type":"object","example":{"urls":["https://example.org"],"skip":0,"returnCount":20}},"V2CompaniesByWebsitePostBody":{"title":"POST /v2/companies/by-website","description":"Same inputs as the GET query parameters; use POST when the URL is too long for a query string. Full shape is under Schema; example is minimal.","required":["url"],"properties":{"url":{"description":"Website URL to match (normalised).","type":"string","maxLength":8192},"skip":{"description":"Number of results to skip (pagination).","type":"integer","minimum":0},"returnCount":{"description":"Page size. Omit to use the API default.","type":"integer","nullable":true,"maximum":10000,"minimum":1}},"type":"object","example":{"url":"https://example.org","skip":0,"returnCount":20}},"AdminEmailActionErrorResponseBody":{"description":"Validation or not-found error for enable/disable API access.","properties":{"status":{"type":"string","example":"error","enum":["error"]},"message":{"type":"string","example":"User not found"}},"type":"object"},"AdminEmailActionSimpleResponseBody":{"description":"Success body for enable/disable API access.","properties":{"status":{"type":"string","example":"success","enum":["success"]}},"type":"object"},"AdminUsersWithApiAccessResponseBody":{"description":"Users who have at least one Sanctum personal access token.","properties":{"user_ids":{"type":"array","items":{"type":"integer","format":"int64"}},"users":{"type":"array","items":{"properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string","format":"email"},"name":{"type":"string"}},"type":"object"}}},"type":"object"},"CompaniesByWebsiteResponseBody":{"description":"Website URL lookup: total matches and one page of company rows from the product API.","properties":{"matchcount":{"description":"Total companies matching the normalised URL (not only this page).","type":"integer"},"companies":{"description":"Current page; shape aligns with ClassifiedCompany where fields are returned.","type":"array","items":{"$ref":"#/components/schemas/ClassifiedCompany"}}},"type":"object"},"CompanyDetailsBatchResponseBody":{"description":"One entry per requested company number, in request order. Entries may be sparse or null when a company is not found (upstream behaviour).","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ClassifiedCompany"}],"nullable":true}},"CompanyNumberExistenceRow":{"description":"Per company number: whether it exists in the product database.","properties":{"CompanyNumber":{"description":"Companies House company number as requested.","type":"string"},"InDatabase":{"description":"True if the company is known to the product API.","type":"boolean"}},"type":"object"},"CompanyNumberSetStatusResponseBody":{"description":"Metadata for an existing uploaded set.","properties":{"setId":{"type":"string"},"exists":{"type":"boolean"},"count":{"type":"integer","format":"int64"},"expiresAt":{"type":"string","format":"date-time"}},"type":"object"},"CompanyNumberSetUploadResponseBody":{"description":"Returned after uploading a plaintext company-number set.","properties":{"setId":{"description":"Pass as `CompanyNumberSetId` on filter / filtered-company requests.","type":"string"},"count":{"description":"Number of company numbers stored.","type":"integer","format":"int64"},"expiresAt":{"description":"When the set stops being valid for use.","type":"string","format":"date-time"}},"type":"object"},"FilteredCompaniesResponseBody":{"description":"Filtered / classify list response from the product API. Top-level keys use camelCase JSON (`companies`, `insights`); the `ListInsights` component schema describes the **shape** of the `insights` object, not its JSON key name.","properties":{"companies":{"description":"Company objects (`ClassifiedCompany`) or plain company number strings when `ReturnCompanyIDsOnly` is set.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ClassifiedCompany"},{"type":"string"}]}},"insights":{"oneOf":[{"$ref":"#/components/schemas/ListInsights"}],"nullable":true,"description":"Present when the `insights` query parameter is true and the token supports it. Field names inside this object are PascalCase (see data dictionary / `ListInsights` schema)."},"CompanyChanges":{"description":"Omitted without `companies:changes`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingsBySOC4Code":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingsBySOC4Name":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingsByLotName":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"AverageAdvertisedSalaryBySOC4Code":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"AverageAdvertisedSalaryBySOC4Name":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"AverageAdvertisedSalaryByLotName":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingsBySkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"AveragePostingDurationBySkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"RTICJobPostings":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"RTICVerticalJobPostings":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"CICJobPostings":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"CICVerticalJobPostings":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"CompanyJobPostingsOverTimeBySOC4":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"CompanyJobPostingsOverTimeByLOT":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingsByCommonSkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"AveragePostingDurationByCommonSkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingsByCertificationsSkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"AveragePostingDurationByCertificationsSkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingsBySpecializedSkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"AveragePostingDurationBySpecializedSkill":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingInsights":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true},"JobPostingInsightsLOT":{"description":"Omitted without `lightcast:read`.","type":"array","items":{"type":"object"},"nullable":true}},"type":"object"},"HttpMessageResponseBody":{"description":"Typical Laravel JSON error envelope.","properties":{"message":{"type":"string"}},"type":"object"},"PostCheckCompaniesResponseBody":{"description":"One row per input company number, in the same order as `companyNumbers` in the request.","type":"array","items":{"$ref":"#/components/schemas/CompanyNumberExistenceRow"}},"ProductApiPassthroughObject":{"description":"JSON object returned from the upstream product API with no extra shaping by this gateway. Exact properties depend on the operation. Fields may be omitted when the token lacks optional scopes (see `config/api.php` scope_field_map).","type":"object","additionalProperties":true},"SmartListIdsResponseBody":{"description":"Smart list or explore list identifiers visible to the caller for the given domain or email.","type":"array","items":{"oneOf":[{"type":"integer"},{"type":"string"}]}},"SmartListOrExploreListResponseBody":{"description":"This gateway prefixes `ListName` then merges the product API classify or filtered-companies payload.","allOf":[{"properties":{"ListName":{"description":"Display name of the smart list or explore list in the platform.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/FilteredCompaniesResponseBody"}]},"SummaryByDomainResponseBody":{"required":["Domain","Website","SummaryText"],"properties":{"Domain":{"type":"string","example":"thedatacity.com"},"Website":{"type":"string","example":"https://thedatacity.com"},"SummaryText":{"type":"string","example":"The Data City provides real-time company intelligence."}},"type":"object"},"WebTextByDomainResponseBody":{"required":["Domain","WebText"],"properties":{"Domain":{"type":"string","example":"thedatacity.com"},"WebText":{"type":"string","example":"Understand what companies"}},"type":"object"}},"parameters":{"ApiPathCompanyNumber":{"name":"companyNumber","in":"path","description":"Companies House company number.","required":true,"schema":{"type":"string"}},"ApiPathPersonNumber":{"name":"personNumber","in":"path","description":"Director person number.","required":true,"schema":{"type":"integer"}},"ApiPathListId":{"name":"listId","in":"path","description":"ML or Explore list ID from the platform.","required":true,"schema":{"type":"integer"}},"ApiPathDomain":{"name":"domain","in":"path","description":"Hostname (e.g. example.com).","required":true,"schema":{"type":"string"}},"ApiPathEmail":{"name":"email","in":"path","description":"Email address (URL-encoded if needed).","required":true,"schema":{"type":"string","format":"email"}},"ApiPathSearchKeyword":{"name":"keyword","in":"path","description":"Full-text search keyword.","required":true,"schema":{"type":"string"}},"ApiPathCompanyNumberSetId":{"name":"setId","in":"path","description":"32-character hex set ID returned from POST /v2/company-number-sets (dashes optional).","required":true,"schema":{"type":"string"}},"ApiQueryInsights":{"name":"insights","in":"query","description":"When true, include dashboard-style insights in the filtered-companies response.","required":false,"schema":{"type":"boolean"}},"ApiQueryPaginationSkip":{"name":"skip","in":"query","description":"Number of records to skip (pagination).","required":false,"schema":{"type":"integer","minimum":0}},"ApiQueryPaginationReturnCountList":{"name":"returnCount","in":"query","description":"Page size for list responses (default 40, max 1000).","required":false,"schema":{"type":"integer","default":40,"maximum":1000,"minimum":1}},"ApiQueryIncludeFilters":{"name":"includeFilters","in":"query","description":"When true, use the list's saved filter payload instead of default filters.","required":false,"schema":{"type":"boolean"}},"ApiQueryCompanyStatus":{"name":"CompanyStatus","in":"query","description":"Company status filter passed through to classification (default Active).","required":false,"schema":{"type":"string","default":"Active"}},"ApiQueryExploreInsights":{"name":"insights","in":"query","description":"String flag forwarded to filtered-companies (default false).","required":false,"schema":{"type":"string","default":"false"}},"ApiQueryModelCode":{"name":"modelCode","in":"query","description":"Classifier model code.","required":true,"schema":{"type":"string"}},"ApiQueryCutoff":{"name":"cutoff","in":"query","description":"Cutoff value for list summary.","required":true,"schema":{"type":"integer"}},"ApiQueryExplainClassifierYes":{"name":"Yes","in":"query","description":"Semicolon-separated company numbers (positive training set).","required":true,"schema":{"type":"string"}},"ApiQueryExplainClassifierNo":{"name":"No","in":"query","description":"Semicolon-separated company numbers (negative training set).","required":true,"schema":{"type":"string"}},"ApiQueryExplainCompanyModelcode":{"name":"modelcode","in":"query","description":"Model code (lowercase query key as implemented).","required":true,"schema":{"type":"string"}},"ApiQueryExplainCompanyCompanynumber":{"name":"companynumber","in":"query","description":"Company number (lowercase query key as implemented).","required":true,"schema":{"type":"string"}},"ApiQueryIncludeSimilarCompanies":{"name":"includeSimilarCompanies","in":"query","description":"When true, response includes SimilarCompanies.","required":false,"schema":{"type":"boolean"}},"ApiQueryIncludeSimilarCompositeCompanies":{"name":"includeSimilarCompositeCompanies","in":"query","description":"When true, response includes SimilarCompositeCompanies.","required":false,"schema":{"type":"boolean"}},"ApiQueryIncludeChangelog":{"name":"includeChangelog","in":"query","description":"When true, response includes CompanyChanges.","required":false,"schema":{"type":"boolean"}},"V2CompaniesByWebsiteUrl":{"name":"url","in":"query","description":"Website URL to match (normalised).","required":true,"schema":{"type":"string","maxLength":8192}},"V2CompaniesByWebsiteSkip":{"name":"skip","in":"query","description":"Number of results to skip (pagination).","required":false,"schema":{"type":"integer","minimum":0}},"V2CompaniesByWebsiteReturnCount":{"name":"returnCount","in":"query","description":"Page size. Omit to use the API default.","required":false,"schema":{"type":"integer","nullable":true,"maximum":10000,"minimum":1}}},"requestBodies":{"CompanyNumberSetPlaintextUpload":{"description":"One company number per line.","required":true,"content":{"text/plain":{"schema":{"description":"Plain-text upload body for POST /v2/company-number-sets (optional gzip + Content-Encoding: gzip).","type":"string","example":"01234567\\n89012345"}}}}},"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"},"datacityApiKey":{"type":"apiKey","description":"Internal admin routes (`/admin/...`). Value must match `DATACITY_API_KEY`.","name":"X-API-Key","in":"header"}}},"tags":[{"name":"classification","description":"Classification and ML: classify companies, list summary, explain classifier, explain company score."},{"name":"companies","description":"Companies: details, group structure, check, batch, export, filtered companies."},{"name":"directors","description":"Directors: director details by person number."},{"name":"explore","description":"Explore lists: filter-based lists by list ID, domain, or email."},{"name":"filters","description":"Filters: get available filters and filtered company results."},{"name":"rtics","description":"RTIC details and metadata."},{"name":"search","description":"Search: ahead full and full-text search."},{"name":"smart-lists","description":"User lists (ML): list details by list ID, domain, or email."}]}