> ## 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 companies in batch

> Returns up to 1000 companies by company number as host-defined JSON elements.



## OpenAPI

````yaml /global-api/ie.openapi.json post /v1/ie/companies/batch
openapi: 3.1.0
info:
  title: The Data City — Ireland company data
  description: >-
    Company data for Ireland, served through The Data City public API gateway.


    Authenticate with an API key as a bearer token. Rate limit is 60 requests
    per minute per key. Call GET /v1/ie/filters before filtering: sector codes
    and location values cannot be guessed, and an unrecognised value returns an
    empty result rather than an error.
  termsOfService: https://thedatacity.com/terms-and-conditions/
  contact:
    name: The Data City
    email: hello@thedatacity.com
  version: v1
servers:
  - url: https://global-api.thedatacity.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Companies
  - name: Search
  - name: Filters
  - name: Lookups
  - name: Classification
  - name: Metadata
paths:
  /v1/ie/companies/batch:
    post:
      tags:
        - Companies
      summary: Get companies in batch
      description: >-
        Returns up to 1000 companies by company number as host-defined JSON
        elements.
      operationId: ie_post_companies_batch
      requestBody:
        content:
          application/json:
            schema: {}
          text/json:
            schema: {}
          application/*+json:
            schema: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProcessedCompany'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: No API key was supplied, or it is not valid for this environment.
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            Rate limit exceeded — 60 requests per minute per key. The
            retry-after header gives the number of seconds to wait.
          headers:
            retry-after:
              description: Seconds to wait before retrying.
              schema:
                type: integer
        '500':
          description: Internal Server Error
components:
  schemas:
    ProcessedCompany:
      required:
        - CompanyNumber
      type: object
      properties:
        Description:
          type: string
          description: Company description or business activity summary
          nullable: true
        LegalForm:
          type: string
          description: Legal form of the company
          nullable: true
        EmployeeRange:
          type: string
          description: Employee count range bucket label
          nullable: true
        RTICs:
          type: array
          items:
            $ref: '#/components/schemas/RTIC'
          description: >-
            Real-Time Industrial Classifications (RTIC) associated with the
            company.
          nullable: true
        LogoURL:
          type: string
          description: URL of the company logo
          nullable: true
        ScreenshotURL:
          type: string
          description: URL of the company screenshot
          nullable: true
        OperatingLocationsCount:
          type: integer
          description: >-
            Number of operating or group locations stored on the company row
            (without returning the full list).
          format: int32
          nullable: true
        CompanyNumber:
          minLength: 1
          type: string
          description: Unique company identifier from the data source
        Name:
          type: string
          description: Official company name
          nullable: true
        Website:
          type: string
          nullable: true
        Country:
          type: string
          description: Country where the company is registered (defaults to "USA")
          nullable: true
        HQAddress:
          type: string
          description: Headquarters address
          nullable: true
        HQPostcode:
          type: string
          description: Headquarters postal code
          nullable: true
        HQPostcodeDetails:
          $ref: '#/components/schemas/CompanyAddress'
        Address:
          type: string
          description: Street address of the company headquarters
          nullable: true
        Town:
          type: string
          description: City or town where the company is located
          nullable: true
        State:
          type: string
          description: State where the company is registered
          nullable: true
        Phone:
          type: string
          description: Primary business phone number
          nullable: true
        Zipcode:
          type: string
          description: Postal code for the company
          nullable: true
        Latitude:
          type: number
          description: Latitude of the company
          format: double
          nullable: true
        Longitude:
          type: number
          description: Longitude of the company
          format: double
          nullable: true
        Employees:
          type: integer
          description: Exact number of employees
          format: int32
          nullable: true
        Turnover:
          type: integer
          description: Annual revenue/turnover value
          format: int64
          nullable: true
        NACEs:
          type: array
          items:
            type: string
          description: Primary industry classification rows associated with the company
          nullable: true
        RNACEs:
          type: array
          items:
            $ref: '#/components/schemas/RNace'
          description: Secondary industry classification rows associated with the company
          nullable: true
        SimilarCompanies:
          type: array
          items:
            $ref: '#/components/schemas/SimilarCompany'
          description: Similar companies to the current company
          nullable: true
      additionalProperties: false
      description: Processed company data with comprehensive business information
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    Problem:
      type: object
      description: Error response, following RFC 9457 (problem details for HTTP APIs).
      properties:
        type:
          type: string
          description: URI identifying the problem type.
        title:
          type: string
          description: Short, human-readable summary.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Explanation specific to this occurrence.
        instance:
          type: string
          description: The path that produced the error.
    RTIC:
      type: object
      properties:
        CompanyNumber:
          type: string
          description: >-
            Company identifier (RTIC parquet key column, aliased to
            `CompanyNumber` in SQL).
          nullable: true
        SectorCode:
          type: string
          description: RTIC sector code.
          nullable: true
        SectorName:
          type: string
          description: RTIC sector name.
          nullable: true
        VerticalCode:
          type: string
          description: RTIC vertical code.
          nullable: true
        VerticalName:
          type: string
          description: RTIC vertical name.
          nullable: true
        Score:
          type: number
          description: Classification score from the RTIC model.
          format: double
          nullable: true
        WordsMatched:
          type: integer
          description: Number of words matched when classifying.
          format: int32
          nullable: true
        Name:
          type: string
          description: Optional display name (when present in source data).
          nullable: true
      additionalProperties: false
      description: >-
        Real-Time Industrial Classifications (RTIC) row. Parquet company id is
        selected as TDC_Global_Server_API_Core.Models.RTIC.CompanyNumber (see
        TDC_Global_Server_API_Core.Services.RTICService). JSON uses the property
        name `CompanyNumber`; country hosts may use different JSON names for the
        root company identifier (e.g. France exposes `Siren` on the company
        payload).
    CompanyAddress:
      type: object
      properties:
        DepartmentName:
          type: string
          description: The name of the department
          nullable: true
        OrganisationName:
          type: string
          description: The name of the organisation
          nullable: true
        SubBuildingName:
          type: string
          description: The name of the sub-building
          nullable: true
        BuildingName:
          type: string
          description: The name of the building
          nullable: true
        POBoxNumber:
          type: string
          description: The number of the PO box
          nullable: true
        BuildingNumber:
          type: string
          description: The number of the building
          nullable: true
        BuildingGroup:
          type: string
          description: The group of the building
          nullable: true
        DependentStreet:
          type: string
          description: The dependent street
          nullable: true
        MainStreet:
          type: string
          description: The main street
          nullable: true
        DoubleDependentLocality:
          type: string
          description: The double dependent locality
          nullable: true
        DependentLocality:
          type: string
          description: The dependent locality
          nullable: true
        PostTown:
          type: string
          description: The post town
          nullable: true
        County:
          type: string
          description: The county
          nullable: true
        Postcode:
          type: string
          description: The postcode
          nullable: true
        Latitude:
          type: number
          description: The latitude
          format: double
          nullable: true
        Longitude:
          type: number
          description: The longitude
          format: double
          nullable: true
      additionalProperties: false
      description: Model representing a Germany address
    RNace:
      type: object
      properties:
        CompanyNumber:
          type: string
          description: Unique Company Number for the company
          nullable: true
        Code:
          type: string
          description: Code aligned with a primary industry code
          nullable: true
        Name:
          type: string
          description: Name/description from the primary code dictionary when enriched
          nullable: true
        Score:
          type: number
          description: >-
            Score indicating the relevance or match strength of this
            classification
          format: double
          nullable: true
      additionalProperties: false
      description: >-
        Model representing TDC_Global_Server_API_IE.Models.RNace (secondary
        industry classification) rows.

        TDC_Global_Server_API_IE.Models.RNace.Code aligns with a primary NACEs
        code; data lives in a separate parquet file.
    SimilarCompany:
      required:
        - CompanyNumber
        - SimilarityScore
      type: object
      properties:
        CompanyNumber:
          type: string
          description: >-
            The similar company identifier (host-specific format, e.g. SIREN or
            US company number).
          nullable: true
        SimilarityScore:
          type: number
          description: Similarity score for this pair.
          format: double
      additionalProperties: false
      description: Represents a similarity score between two companies.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        An API key issued by The Data City, sent as: Authorization: Bearer
        YOUR_KEY

````