> ## Documentation Index
> Fetch the complete documentation index at: https://docs.datadingo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Company search: exact filters, one fixed sort

> Custom endpoint (ADR-0018). Exact `filters`, then one `sort`: `relevance` (fit to free text `q`, likeness to `similar_to` or to a seed list `similar_to_many`, 1–10 domains) or a stored-field sort over every filtered company (`best_known`, `largest`). Needs at least one filter, or `q` / a seed. `limit: 0` counts only; `ids_only: true` answers the page's ids instead of cards. Results are short cards, one per company record (website); call `GET /v1/company?id=` for the full card. Each user may receive 5,000 search cards a UTC day (counts and ids-only searches are not counted); past that a card search is a 429.



## OpenAPI

````yaml /openapi.json post /v1/company/search
openapi: 3.1.0
info:
  title: DataDingo API
  description: Company enrichment API.
  version: 1.0.0
  termsOfService: https://datadingo.com/terms
servers:
  - url: https://api.datadingo.com
security:
  - bearerAuth: []
paths:
  /v1/company/search:
    post:
      tags:
        - Company
      summary: 'Company search: exact filters, one fixed sort'
      description: >-
        Custom endpoint (ADR-0018). Exact `filters`, then one `sort`:
        `relevance` (fit to free text `q`, likeness to `similar_to` or to a seed
        list `similar_to_many`, 1–10 domains) or a stored-field sort over every
        filtered company (`best_known`, `largest`). Needs at least one filter,
        or `q` / a seed. `limit: 0` counts only; `ids_only: true` answers the
        page's ids instead of cards. Results are short cards, one per company
        record (website); call `GET /v1/company?id=` for the full card. Each
        user may receive 5,000 search cards a UTC day (counts and ids-only
        searches are not counted); past that a card search is a 429.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              description: >-
                Needs at least one filter, or `q`, `similar_to` or
                `similar_to_many` (enforced in the handler — JSON Schema can't
                express it cleanly with optional fields). Results are one row
                per company record (website): two websites that share an ABN are
                two results.
              additionalProperties: false
              type: object
              properties:
                q:
                  minLength: 1
                  maxLength: 1000
                  description: >-
                    Free text that ORDERS the results by fit (`sort:
                    relevance`): its meaning matched against each company's
                    description, fused with a word match on names and
                    specialties that needs EVERY word of `q` (small words like
                    "the" ignored), so keep `q` to the few words that describe
                    the company ("commercial cleaning", not "companies that do
                    commercial cleaning in Sydney"). It only ranks; it never
                    filters, and nothing is read out of it. Put places in
                    `filters.state` / `filters.locality`, a kind of company with
                    no industry label in `filters.keywords`, and use
                    `lookup_by_name` for one specific company. Each of its two
                    rankings reaches only its top 600 (about 1,200 together), so
                    it gives the best fits first, not all of them; leave it out
                    when the filters already say what kind of company.
                  type: string
                similar_to:
                  minLength: 1
                  maxLength: 255
                  description: >-
                    Registrable domain (or FQDN) of a seed company. Its stored
                    vector is used as the query. 404 if the seed has no
                    embedding.
                  type: string
                similar_to_many:
                  minItems: 1
                  maxItems: 10
                  description: >-
                    Lookalikes of a list of companies: 1–10 registrable domains
                    of seed companies (e.g. a customer list). Returns companies
                    like the seeds as a group; the seeds themselves are never in
                    `results`. A seed with no embedding is listed in the
                    response's `seeds_missing` instead of failing the search —
                    404 only when no seed has one. Use either `similar_to` or
                    `similar_to_many`, not both.
                  type: array
                  items:
                    minLength: 1
                    maxLength: 255
                    type: string
                filters:
                  description: >-
                    Exact filters: a result passes every filter set. A
                    list-valued filter takes one value or a non-empty list
                    (matches any); an empty list is a 400 — omit the filter
                    instead.
                  additionalProperties: false
                  type: object
                  properties:
                    industry:
                      description: >-
                        LinkedIn industry label(s) from `list_industries` (one
                        or a list).
                      anyOf:
                        - type: string
                        - minItems: 1
                          type: array
                          items:
                            type: string
                    industry_exclude:
                      description: >-
                        LinkedIn industry label(s) from `list_industries` to
                        remove (one or a list).
                      anyOf:
                        - type: string
                        - minItems: 1
                          type: array
                          items:
                            type: string
                    state:
                      description: >-
                        Office state(s): NSW, VIC, QLD, SA, WA, TAS, NT, ACT
                        (one or a list).
                      anyOf:
                        - type: string
                        - minItems: 1
                          type: array
                          items:
                            type: string
                    hq_state:
                      description: >-
                        Head-office state(s): NSW, VIC, QLD, SA, WA, TAS, NT,
                        ACT (one or a list).
                      anyOf:
                        - type: string
                        - minItems: 1
                          type: array
                          items:
                            type: string
                    locality:
                      maxLength: 100
                      description: >-
                        A suburb, city or 4-digit postcode where the company has
                        an office.
                      type: string
                    rdti_active:
                      description: 'true: has claimed the R&D Tax Incentive.'
                      type: boolean
                    ato_total_income_min:
                      minimum: 0
                      description: >-
                        Minimum ATO total income, whole AUD. The ATO publishes
                        income only for entities of $100M or more; for smaller
                        companies use `employee_range`.
                      type: integer
                    ato_total_income_max:
                      minimum: 0
                      description: >-
                        Maximum ATO total income, whole AUD. The ATO publishes
                        income only for entities of $100M or more; for smaller
                        companies use `employee_range`.
                      type: integer
                    min_abn_confidence:
                      minimum: 0
                      maximum: 1
                      description: Minimum ABN link confidence, 0 to 1.
                      type: number
                    min_abn_level:
                      description: 'Minimum ABN link level: high, medium, low.'
                      anyOf:
                        - type: string
                          enum:
                            - high
                        - type: string
                          enum:
                            - medium
                        - type: string
                          enum:
                            - low
                    news_published_after:
                      pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
                      description: Newest news post on or after this day, YYYY-MM-DD.
                      type: string
                    news_event_type:
                      description: >-
                        News event type(s): `acquisition_merger`,
                        `leadership_change`, `contract_win`, `award_recognition`
                        (one or a list).
                      anyOf:
                        - anyOf:
                            - type: string
                              enum:
                                - acquisition_merger
                            - type: string
                              enum:
                                - leadership_change
                            - type: string
                              enum:
                                - contract_win
                            - type: string
                              enum:
                                - award_recognition
                        - minItems: 1
                          type: array
                          items:
                            anyOf:
                              - type: string
                                enum:
                                  - acquisition_merger
                              - type: string
                                enum:
                                  - leadership_change
                              - type: string
                                enum:
                                  - contract_win
                              - type: string
                                enum:
                                  - award_recognition
                    news_event_after:
                      pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
                      description: A news event on or after this day, YYYY-MM-DD.
                      type: string
                    llms_txt:
                      description: >-
                        Website /llms.txt: authored, generated, none (one or a
                        list).
                      anyOf:
                        - anyOf:
                            - type: string
                              enum:
                                - authored
                            - type: string
                              enum:
                                - generated
                            - type: string
                              enum:
                                - none
                        - minItems: 1
                          type: array
                          items:
                            anyOf:
                              - type: string
                                enum:
                                  - authored
                              - type: string
                                enum:
                                  - generated
                              - type: string
                                enum:
                                  - none
                    ai_training:
                      description: 'Website AI-training stance: opted_out, silent.'
                      anyOf:
                        - type: string
                          enum:
                            - opted_out
                        - type: string
                          enum:
                            - silent
                    technology:
                      description: >-
                        Technology vendor name(s) detected on the company's
                        website, e.g. WordPress, Shopify, HubSpot (one or a
                        list).
                      anyOf:
                        - type: string
                        - minItems: 1
                          type: array
                          items:
                            type: string
                    technology_match:
                      description: >-
                        How to combine filters.technology: any (default) matches
                        one or more; all requires every selected vendor. Has no
                        effect without technology names.
                      anyOf:
                        - type: string
                          enum:
                            - any
                        - type: string
                          enum:
                            - all
                    technology_category:
                      description: >-
                        Technology category: Website platform, Ecommerce,
                        Analytics, Advertising, Forms, Live chat, CRM &
                        marketing, Booking, Payments, Reviews, Email provider,
                        Email sending, Hosting & CDN, DNS provider (one or a
                        list).
                      anyOf:
                        - anyOf:
                            - type: string
                              enum:
                                - Website platform
                            - type: string
                              enum:
                                - Ecommerce
                            - type: string
                              enum:
                                - Analytics
                            - type: string
                              enum:
                                - Advertising
                            - type: string
                              enum:
                                - Forms
                            - type: string
                              enum:
                                - Live chat
                            - type: string
                              enum:
                                - CRM & marketing
                            - type: string
                              enum:
                                - Booking
                            - type: string
                              enum:
                                - Payments
                            - type: string
                              enum:
                                - Reviews
                            - type: string
                              enum:
                                - Email provider
                            - type: string
                              enum:
                                - Email sending
                            - type: string
                              enum:
                                - Hosting & CDN
                            - type: string
                              enum:
                                - DNS provider
                        - minItems: 1
                          type: array
                          items:
                            anyOf:
                              - type: string
                                enum:
                                  - Website platform
                              - type: string
                                enum:
                                  - Ecommerce
                              - type: string
                                enum:
                                  - Analytics
                              - type: string
                                enum:
                                  - Advertising
                              - type: string
                                enum:
                                  - Forms
                              - type: string
                                enum:
                                  - Live chat
                              - type: string
                                enum:
                                  - CRM & marketing
                              - type: string
                                enum:
                                  - Booking
                              - type: string
                                enum:
                                  - Payments
                              - type: string
                                enum:
                                  - Reviews
                              - type: string
                                enum:
                                  - Email provider
                              - type: string
                                enum:
                                  - Email sending
                              - type: string
                                enum:
                                  - Hosting & CDN
                              - type: string
                                enum:
                                  - DNS provider
                    web_reach_level:
                      description: >-
                        Web reach level(s): none, low, medium, high (one or a
                        list).
                      anyOf:
                        - anyOf:
                            - type: string
                              enum:
                                - none
                            - type: string
                              enum:
                                - low
                            - type: string
                              enum:
                                - medium
                            - type: string
                              enum:
                                - high
                        - minItems: 1
                          type: array
                          items:
                            anyOf:
                              - type: string
                                enum:
                                  - none
                              - type: string
                                enum:
                                  - low
                              - type: string
                                enum:
                                  - medium
                              - type: string
                                enum:
                                  - high
                    web_reach_trend:
                      description: >-
                        Web reach trend(s): growing, steady,
                        too_small_to_measure (one or a list).
                      anyOf:
                        - anyOf:
                            - type: string
                              enum:
                                - growing
                            - type: string
                              enum:
                                - steady
                            - type: string
                              enum:
                                - too_small_to_measure
                        - minItems: 1
                          type: array
                          items:
                            anyOf:
                              - type: string
                                enum:
                                  - growing
                              - type: string
                                enum:
                                  - steady
                              - type: string
                                enum:
                                  - too_small_to_measure
                    keywords:
                      description: >-
                        Word(s) or phrase(s) in the company's names or LinkedIn
                        specialties (one or a list of up to 50).
                      anyOf:
                        - minLength: 1
                          maxLength: 200
                          type: string
                        - minItems: 1
                          maxItems: 50
                          type: array
                          items:
                            minLength: 1
                            maxLength: 200
                            type: string
                    keywords_exclude:
                      description: >-
                        Word(s) or phrase(s) that remove a company (one or a
                        list of up to 50).
                      anyOf:
                        - minLength: 1
                          maxLength: 200
                          type: string
                        - minItems: 1
                          maxItems: 50
                          type: array
                          items:
                            minLength: 1
                            maxLength: 200
                            type: string
                    employee_range:
                      description: >-
                        Size band(s): 1, 2-10, 11-50, 51-200, 201-500, 501-1000,
                        1001-5000, 5001-10000, 10001+ (one or a list). Pass the
                        bands a headcount range covers, not ones it only touches
                        at a boundary: "10 to 50 staff" is `11-50`; "5 to 50" is
                        `["2-10", "11-50"]`.
                      anyOf:
                        - anyOf:
                            - type: string
                              enum:
                                - '1'
                            - type: string
                              enum:
                                - 2-10
                            - type: string
                              enum:
                                - 11-50
                            - type: string
                              enum:
                                - 51-200
                            - type: string
                              enum:
                                - 201-500
                            - type: string
                              enum:
                                - 501-1000
                            - type: string
                              enum:
                                - 1001-5000
                            - type: string
                              enum:
                                - 5001-10000
                            - type: string
                              enum:
                                - 10001+
                        - minItems: 1
                          type: array
                          items:
                            anyOf:
                              - type: string
                                enum:
                                  - '1'
                              - type: string
                                enum:
                                  - 2-10
                              - type: string
                                enum:
                                  - 11-50
                              - type: string
                                enum:
                                  - 51-200
                              - type: string
                                enum:
                                  - 201-500
                              - type: string
                                enum:
                                  - 501-1000
                              - type: string
                                enum:
                                  - 1001-5000
                              - type: string
                                enum:
                                  - 5001-10000
                              - type: string
                                enum:
                                  - 10001+
                sort:
                  description: >-
                    The order of the results, one of a fixed list. `relevance`:
                    fit to `q` or likeness to the seed(s) — the default when
                    `q`, `similar_to` or `similar_to_many` is set, and a 400
                    without one. `best_known`: the best-known companies first —
                    the default for a filters-only search. `largest`: biggest
                    LinkedIn size band first, no band last, then best known
                    within a band. `best_known` and `largest` with `q` or a seed
                    is a 400: put the kind of company into `filters` instead.
                    The sort applied is echoed in `interpreted.sort`.
                  anyOf:
                    - type: string
                      enum:
                        - relevance
                    - type: string
                      enum:
                        - best_known
                    - type: string
                      enum:
                        - largest
                limit:
                  minimum: 0
                  maximum: 100
                  default: 25
                  description: >-
                    Results per page, 0–100. `0` is a count-only search: no
                    results, just `total` (and `offset` is ignored). With `q`,
                    `total` is the whole filtered pool, so a count says little
                    about how many fit the words.
                  type: integer
                offset:
                  minimum: 0
                  maximum: 10000
                  default: 0
                  type: integer
                ids_only:
                  description: >-
                    `true` answers `{ ids, total, total_is_capped }` instead of
                    cards: the company ids of the same page, in the same order,
                    with the same `filters` / `sort` / `limit` (0–100) /
                    `offset`. Ids-only searches (like `limit: 0` counts) do not
                    use the daily allowance of free search rows.
                  type: boolean
                exclude_owned:
                  description: >-
                    `true` leaves out every company you already own (have
                    unlocked), from the results AND from `total`, in card, count
                    (`limit: 0`) and ids-only searches. Has no effect for a
                    token with no user.
                  type: boolean
                tz:
                  maxLength: 64
                  description: >-
                    IANA timezone (e.g. Australia/Sydney, the default) used to
                    render `signals.news.last_published_at` as a calendar day
                    and to interpret `news_published_after` as local midnight.
                    Unknown zones are rejected with 400.
                  type: string
        description: >-
          Needs at least one filter, or `q`, `similar_to` or `similar_to_many`
          (enforced in the handler — JSON Schema can't express it cleanly with
          optional fields). Results are one row per company record (website):
          two websites that share an ABN are two results.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                  - description: Search results in `sort` order.
                    type: object
                    required:
                      - total
                      - total_is_capped
                      - already_yours
                      - results
                      - interpreted
                      - seeds_missing
                    properties:
                      total:
                        description: >-
                          `total` is how many companies pass every applied
                          filter (seeds excluded): the pool, not the page.
                          Counting stops at 10,000 (`total_is_capped: true` = at
                          least that many). Under `relevance` the pool is
                          companies with a description vector plus word matches,
                          and only roughly the top 1,200 can be paged with `q`
                          (600 for one seed alone): an empty page is the end of
                          what you can reach, not of the pool, and paging can
                          drift slightly. Under `best_known` / `largest` the
                          pool is every company passing the filters, pageable to
                          `offset` 10,000 with no repeats or skips. So `total`
                          can differ with and without `q`; narrow with `filters`
                          rather than paging deep.
                        anyOf:
                          - type: integer
                          - description: >-
                              Null when counting took too long: the cards are
                              still returned, `total_is_capped` is then false
                              and `already_yours` null.
                            type: 'null'
                      total_is_capped:
                        description: >-
                          True when counting stopped at 10,000, so `total`
                          (10,000) is a lower bound; false when `total` is
                          exact.
                        type: boolean
                      already_yours:
                        description: >-
                          How many of the companies counted in `total` your
                          account already owns (has unlocked), so `total −
                          already_yours` are new to you. Null when
                          `total_is_capped` is true or `total` is null, when you
                          own no companies yet, or for a token with no user.
                        anyOf:
                          - minimum: 0
                            type: integer
                          - type: 'null'
                      results:
                        description: >-
                          The page, in `sort` order: one short card per company
                          (id, name, website, one-line summary, industry,
                          hq_location, states, employee_range, and
                          `matched_office` when `locality` is set). Call
                          `lookup_company` with an `id` for the full card. `[]`
                          for `limit: 0`.
                        type: array
                        items:
                          type: object
                          required:
                            - score
                            - company
                          properties:
                            score:
                              description: >-
                                Under `sort: relevance` — with `q`: the meaning
                                match and the name/specialty text match fused by
                                rank, scaled to (0, 1] (1.0 = ranked first by
                                both; a result only one of them found scores at
                                most ~0.5); with `similar_to` (or
                                `similar_to_many`) alone: cosine similarity in
                                [-1, 1], typically [0, 1]. Null under
                                `best_known` and `largest`, which order by a
                                stored field, not a score.
                              anyOf:
                                - type: number
                                - type: 'null'
                            company:
                              additionalProperties: false
                              type: object
                              required:
                                - id
                                - name
                                - website
                                - summary
                                - industry
                                - hq_location
                                - hq_state
                                - states
                                - employee_range
                                - matched_office
                              properties:
                                id:
                                  description: >-
                                    DataDingo company ID — pass it to
                                    `lookup_company` for the full card.
                                  type: string
                                name:
                                  description: Display name, as on the full card.
                                  type: string
                                website:
                                  description: The company's website, as on the full card.
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                summary:
                                  description: >-
                                    The card's `description` on one line: cut at
                                    the last sentence end within 200 characters,
                                    or a hard cut ending in "…". Null when there
                                    is no description.
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                industry:
                                  description: >-
                                    The LinkedIn industry label
                                    (`industry.linkedin.label` on the full
                                    card).
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                hq_location:
                                  description: >-
                                    Head-office suburb or city, as on the full
                                    card.
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                hq_state:
                                  description: >-
                                    State or territory of the head office; null
                                    when the head office is outside Australia or
                                    its state is unknown. The state the
                                    `hq_state` filter matches.
                                  anyOf:
                                    - anyOf:
                                        - type: string
                                          enum:
                                            - NSW
                                        - type: string
                                          enum:
                                            - VIC
                                        - type: string
                                          enum:
                                            - QLD
                                        - type: string
                                          enum:
                                            - SA
                                        - type: string
                                          enum:
                                            - WA
                                        - type: string
                                          enum:
                                            - TAS
                                        - type: string
                                          enum:
                                            - NT
                                        - type: string
                                          enum:
                                            - ACT
                                    - type: 'null'
                                states:
                                  description: >-
                                    Every Australian state or territory the
                                    company has an office in, head office first
                                    — what the `state` filter matches (`states`
                                    on the full card). One entry for most
                                    companies; `[]` when none is known.
                                  type: array
                                  items:
                                    type: string
                                employee_range:
                                  description: >-
                                    LinkedIn size band, as on the full card;
                                    null = not measured, not small.
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                matched_office:
                                  description: >-
                                    With a `locality` filter: the office that
                                    matched it when that is NOT the head office
                                    (any stored office, including ones the full
                                    card's `locations` does not list). Null when
                                    the head office matches (`hq_location`
                                    already names it), with no `locality`
                                    filter, and on `lookup_by_name`.
                                  anyOf:
                                    - additionalProperties: false
                                      type: object
                                      required:
                                        - locality
                                        - state
                                        - postcode
                                      properties:
                                        locality:
                                          description: Suburb or town of the matched office.
                                          anyOf:
                                            - type: string
                                            - type: 'null'
                                        state:
                                          description: >-
                                            State or territory of the matched
                                            office.
                                          anyOf:
                                            - type: string
                                            - type: 'null'
                                        postcode:
                                          description: Postcode of the matched office.
                                          anyOf:
                                            - type: string
                                            - type: 'null'
                                    - type: 'null'
                      interpreted:
                        additionalProperties: false
                        description: >-
                          What the search applied: always the `sort`, plus the
                          expanded industry and city filters. Nothing is read
                          out of `q`.
                        type: object
                        required:
                          - sort
                        properties:
                          sort:
                            description: The sort actually applied, a default included.
                            anyOf:
                              - type: string
                                enum:
                                  - relevance
                              - type: string
                                enum:
                                  - best_known
                              - type: string
                                enum:
                                  - largest
                          locality:
                            description: >-
                              The city area a caller's own `filters.locality`
                              was widened to, by its full name ("Melbourne" →
                              "Greater Melbourne"). Absent when
                              `filters.locality` is unset or names a suburb or
                              postcode.
                            type: string
                          industry:
                            additionalProperties: false
                            type: object
                            required:
                              - included
                              - excluded
                            properties:
                              included:
                                description: >-
                                  Every industry label a result may carry:
                                  `filters.industry` expanded to each label and
                                  everything under it, minus `excluded`. `[]`
                                  when only `industry_exclude` was set.
                                type: array
                                items:
                                  type: string
                              excluded:
                                description: >-
                                  Every industry label removed:
                                  `filters.industry_exclude` expanded the same
                                  way.
                                type: array
                                items:
                                  type: string
                      seeds_missing:
                        description: >-
                          The `similar_to_many` seeds (lowercased) that have no
                          embedding, so they did not shape the results. `[]`
                          when every seed was used or no seed list was sent.
                        type: array
                        items:
                          type: string
                  - additionalProperties: false
                    description: >-
                      Ids-only search results (`ids_only: true`) in `sort`
                      order.
                    type: object
                    required:
                      - ids
                      - total
                      - total_is_capped
                    properties:
                      ids:
                        description: >-
                          The company ids of the page, in `sort` order: the same
                          ids the card search returns for the same request. `[]`
                          for `limit: 0`.
                        type: array
                        items:
                          type: string
                      total:
                        description: >-
                          `total` is how many companies pass every applied
                          filter (seeds excluded): the pool, not the page.
                          Counting stops at 10,000 (`total_is_capped: true` = at
                          least that many). Under `relevance` the pool is
                          companies with a description vector plus word matches,
                          and only roughly the top 1,200 can be paged with `q`
                          (600 for one seed alone): an empty page is the end of
                          what you can reach, not of the pool, and paging can
                          drift slightly. Under `best_known` / `largest` the
                          pool is every company passing the filters, pageable to
                          `offset` 10,000 with no repeats or skips. So `total`
                          can differ with and without `q`; narrow with `filters`
                          rather than paging deep.
                        anyOf:
                          - type: integer
                          - description: >-
                              Null when counting took too long: the cards are
                              still returned, `total_is_capped` is then false
                              and `already_yours` null.
                            type: 'null'
                      total_is_capped:
                        description: >-
                          True when counting stopped at 10,000, so `total`
                          (10,000) is a lower bound; false when `total` is
                          exact.
                        type: boolean
        '400':
          description: Standard error response
          content:
            application/json:
              schema:
                description: Standard error response
                type: object
                required:
                  - error
                  - message
                properties:
                  error:
                    description: HTTP status code
                    type: integer
                  message:
                    description: Human-readable error message
                    type: string
        '401':
          description: Standard error response
          content:
            application/json:
              schema:
                description: Standard error response
                type: object
                required:
                  - error
                  - message
                properties:
                  error:
                    description: HTTP status code
                    type: integer
                  message:
                    description: Human-readable error message
                    type: string
        '403':
          description: 'The user''s plan has ended: subscribe to keep using DataDingo'
          content:
            application/json:
              schema:
                description: 'The user''s plan has ended: subscribe to keep using DataDingo'
                type: object
                required:
                  - error
                  - code
                  - message
                  - subscribe_url
                properties:
                  error:
                    description: HTTP status code (403)
                    type: integer
                  code:
                    type: string
                    enum:
                      - plan_required
                  message:
                    description: Human-readable error message, with the subscribe link
                    type: string
                  subscribe_url:
                    description: Where to subscribe to get access back
                    type: string
        '404':
          description: Standard error response
          content:
            application/json:
              schema:
                description: Standard error response
                type: object
                required:
                  - error
                  - message
                properties:
                  error:
                    description: HTTP status code
                    type: integer
                  message:
                    description: Human-readable error message
                    type: string
        '429':
          description: Rate limit exceeded, or today's free search results used up
          content:
            application/json:
              schema:
                description: Rate limit exceeded, or today's free search results used up
                type: object
                required:
                  - error
                  - message
                  - limit
                  - remaining
                  - resets_at
                properties:
                  error:
                    description: HTTP status code (429)
                    type: integer
                  message:
                    description: Human-readable error message
                    type: string
                  limit:
                    description: >-
                      The limit that was hit: requests allowed per minute, or
                      (on `POST /v1/company/search`) search results one user may
                      receive per UTC day
                    type: integer
                  remaining:
                    description: What is left of that limit (0)
                    type: integer
                  resets_at:
                    format: date-time
                    description: >-
                      ISO 8601 instant the limit resets (the next minute, or the
                      next UTC midnight for search results)
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.