> ## Documentation Index > Fetch the complete documentation index at: https://docs.thedatacity.com/llms.txt > Use this file to discover all available pages before exploring further. # Get explore list details > Get explore list details. ## OpenAPI ````yaml /api-reference/openapi.json get /v2/explore/{listId} 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: Production security: [] 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.' paths: /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 components: parameters: ApiPathListId: name: listId in: path description: ML or Explore list ID from the platform. required: true schema: type: integer 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 ApiQueryPaginationSkip: name: skip in: query description: Number of records to skip (pagination). required: false schema: type: integer minimum: 0 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' schemas: 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' 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 ClassifiedCompany: description: >- Generated from The Data City data dictionary (schema ClassifiedCompany, version 1.0). See https://docs.thedatacity.com/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 — 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 — 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 ListInsights: description: >- Generated from The Data City data dictionary (schema ListInsights, version 1.0). See https://docs.thedatacity.com/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 CompanyNumberRtic: description: >- Placeholder: referenced by the data dictionary but no standalone field list is published for this type. See https://docs.thedatacity.com/data-dictionary/ type: object CompanyTrade: description: >- Placeholder: referenced by the data dictionary but no standalone field list is published for this type. See https://docs.thedatacity.com/data-dictionary/ type: object CleanCreditSafeCompany: description: >- Generated from The Data City data dictionary (schema CleanCreditSafeCompany, version 1.0). See https://docs.thedatacity.com/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://docs.thedatacity.com/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, … 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://docs.thedatacity.com/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 CompanyJobPostingByLOTCodeOverTime: description: >- Generated from The Data City data dictionary (schema CompanyJobPostingByLOTCodeOverTime, version 1.0). See https://docs.thedatacity.com/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://docs.thedatacity.com/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://docs.thedatacity.com/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 CompanyJobPostingByCommonSkill: description: >- Generated from The Data City data dictionary (schema CompanyJobPostingByCommonSkill, version 1.0). See https://docs.thedatacity.com/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 CompanyJobPostingsOverTime: description: >- Generated from The Data City data dictionary (schema CompanyJobPostingsOverTime, version 1.0). See https://docs.thedatacity.com/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 PerRoundInvestment: description: >- Generated from The Data City data dictionary (schema PerRoundInvestment, version 1.0). See https://docs.thedatacity.com/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://docs.thedatacity.com/data-dictionary/ type: object ESGStatementAnchor: description: >- Generated from The Data City data dictionary (schema ESGStatementAnchor, version 1.0). See https://docs.thedatacity.com/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 IndustrialStrategySector: description: >- Generated from The Data City data dictionary (schema IndustrialStrategySector, version 1.0). See https://docs.thedatacity.com/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://docs.thedatacity.com/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 PostcodeDetail_grouped: description: >- Generated from The Data City data dictionary (schema PostcodeDetail_grouped, version 1.0). See https://docs.thedatacity.com/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 Officer: description: >- Generated from The Data City data dictionary (schema Officer, version 1.0). See https://docs.thedatacity.com/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 RSIC: description: >- Generated from The Data City data dictionary (schema RSIC, version 1.0). See https://docs.thedatacity.com/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 CompanySimilarity: description: >- Generated from The Data City data dictionary (schema CompanySimilarity, version 1.0). See https://docs.thedatacity.com/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 UrlMatchStat: description: >- Generated from The Data City data dictionary (schema UrlMatchStat, version 1.0). See https://docs.thedatacity.com/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://docs.thedatacity.com/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 BasicGrant360: description: >- Generated from The Data City data dictionary (schema BasicGrant360, version 1.0). See https://docs.thedatacity.com/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 Topinvestor: description: >- Placeholder: referenced by the data dictionary but no standalone field list is published for this type. See https://docs.thedatacity.com/data-dictionary/ type: object YearMeasure: description: >- Generated from The Data City data dictionary (schema YearMeasure, version 1.0). See https://docs.thedatacity.com/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 CompanyJobPostingOverTime: description: >- Generated from The Data City data dictionary (schema CompanyJobPostingOverTime, version 1.0). See https://docs.thedatacity.com/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 securitySchemes: bearerAuth: type: http bearerFormat: JWT scheme: bearer ````