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

# Fetch company details

> Returns enriched company-level data based on the input of a company name, URL, phone number, or address.
URL and phone lookups typically complete in under 1,000 milliseconds. Searches using only the company name may return multiple results.

At least one of `url`, `phone`, `company_name`, or `address` must be provided.
The `url` and `phone` parameters use exact matching, while `company_name` and `address` use fuzzy matching.

The response includes a `records` array of matching companies, each with detailed fields. The `total_records` field specifies the number of matches returned. The set of fields included in the response may vary depending on the data available. See the **Field References** section of the documentation for a breakdown of each field returned in the response.



## OpenAPI

````yaml post /v1/companies
openapi: 3.1.0
info:
  title: LeadX API
  version: 0.1.0
servers: []
security: []
tags:
  - name: All Attributes
    description: Aggregate and correlate data about companies and their associated records.
  - name: Better Business Bureau
    description: >-
      Retrieve Better Business Bureau (BBB) ratings and accreditation status for
      businesses.
  - name: Companies
    description: Enrich company data by URL, name, address, or phone.
  - name: Contacts
    description: Enrich data about contacts.
  - name: email
    description: Validate company email addresses.
  - name: Google Reviews
    description: Retrieve Google Reviews and ratings for businesses.
  - name: Mobile Number
    description: Enrich mobile phone numbers.
  - name: UCC
    description: Search across to the U.S. Uniform Commercial Code (UCC) lien filings.
paths:
  /v1/companies:
    post:
      tags:
        - Companies
      summary: Fetch company details
      description: >-
        Returns enriched company-level data based on the input of a company
        name, URL, phone number, or address.

        URL and phone lookups typically complete in under 1,000 milliseconds.
        Searches using only the company name may return multiple results.


        At least one of `url`, `phone`, `company_name`, or `address` must be
        provided.

        The `url` and `phone` parameters use exact matching, while
        `company_name` and `address` use fuzzy matching.


        The response includes a `records` array of matching companies, each with
        detailed fields. The `total_records` field specifies the number of
        matches returned. The set of fields included in the response may vary
        depending on the data available. See the **Field References** section of
        the documentation for a breakdown of each field returned in the
        response.
      operationId: fetch_companies_v1_companies_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompaniesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
              example:
                success: true
                records:
                  - about_link: https://localcafe.com/about
                    address: 456 Main Street
                    address_full: 456 Main Street, Hometown, TX, 75001, United States
                    addresses_all:
                      - address: 456 Main Street
                        city: Hometown
                        county: Commerce County
                        region: South
                        state: TX
                        zip_code: '75001'
                        zip_lat: 32.7767
                        zip_long: -96.797
                    city: Hometown
                    city_state_country: Hometown, TX, United States
                    classification: Vendor
                    company_id: LOCALCAFE67890
                    company_name: Local Cafe
                    competitors_lookalikes: >-
                      Coffee Spot: coffeespot.com (0.100), Brewed Bliss:
                      brewedbliss.com (0.150)
                    contact_link: https://localcafe.com/contact
                    country: United States
                    county: Commerce County
                    do_you_offer_financing: false
                    eight_digit_sic_code: '58120000'
                    eight_digit_sic_description: Bars and lounges
                    estimated_number_employees: 5
                    estimated_number_employees_bin: 0-10
                    facebook_url: facebook.com/LocalCafe
                    financing_partners: []
                    four_digit_sic_code: '5812'
                    four_digit_sic_description: Eating places
                    generic_emails: []
                    industry: Restaurants
                    instagram_url: instagram.com/localcafe
                    invalid_website: false
                    keywords:
                      - coffee
                      - local cafe
                      - community
                      - fresh pastries
                      - artisan drinks
                    linkedin_description: >-
                      Local Cafe is a cozy spot serving freshly brewed coffee
                      and homemade pastries in the heart of Hometown.
                    linkedin_follower_count: 50
                    linkedin_url: linkedin.com/company/localcafe
                    logo_url: https://localcafe.com/logo.png
                    manufacturer: false
                    menu_navigation: Home, Menu, About, Contact
                    naics_code: '722513'
                    naics_description: Limited-Service Restaurants
                    name_based_emails: []
                    number_of_locations: 1
                    phone:
                      - '9725556789'
                    prediction_probability: 0.4004004895687103
                    region: South
                    state: TX
                    state_name: Texas
                    technology_names: >-
                      Android, Bing Ads, Gmail, Google Analytics, Google Apps,
                      Google Font API, Google Tag Manager, Mobile Friendly,
                      Remote, Shutterstock, WordPress.org, reCAPTCHA
                    time_in_business: 7
                    time_in_business_bin: 5-10 Years
                    timezone: Central
                    twitter_url: twitter.com/LocalCafe
                    two_digit_sic_code: '58'
                    two_digit_sic_description: Eating and Drinking Places
                    url: localcafe.com
                    zip_code: '75001'
                    zip_lat: 32.7767
                    zip_lat_long:
                      - 32.7767
                      - -96.797
                    zip_long: -96.797
                total_records: 1
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    CompaniesRequest:
      properties:
        url:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Url
          description: Company URL (may include or omit the http/https prefix)
          example:
            - https://www.example.com
            - https://information.org
        company_id:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Company Id
          description: Include specific company IDs in the search results
          example:
            - 8Q43UQ592MXFWAZ6ZNGJQP
            - IWNJWMZPAMJH9FJRACSTAT
        phone:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Phone
          description: Company phone (may include or omit the dashes)
          example: 123-456-7890
        company_name:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Company Name
          description: Company name(s)
          example:
            - Acme Inc
            - Global Logistics LLC
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          description: Company address
          example: 123 Main St, Springfield, IL 62701
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
          description: City to filter by
          example: Springfield
        state:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: State
          description: State to filter by (two-letter abbreviation)
          example: CA
        zip_code:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Zip Code
          description: ZIP code to filter by
          example: '90210'
        near_zip_code:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Near Zip Code
          description: ZIP code to search around (anchor). Use with radius/radius_unit.
          example: '92656'
        radius:
          anyOf:
            - type: number
              exclusiveMinimum: 0
            - type: 'null'
          title: Radius
          description: Radius distance for geo search around near_zip_code.
          example: 25
        radius_unit:
          type: string
          enum:
            - mi
            - km
          title: Radius Unit
          description: Units for radius (mi or km).
          default: mi
          example: mi
        county:
          anyOf:
            - type: string
            - type: 'null'
          title: County
          description: County to filter by
          example: Los Angeles County
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Country to filter by
          example: United States
        timezone:
          anyOf:
            - type: string
            - type: 'null'
          title: Timezone
          description: Timezone to filter by
          example: Central
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
          description: Region to filter by
          example: Northeast
        eight_digit_sic_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Eight Digit Sic Code
          description: Eight-digit SIC code to filter by
          example: '58120000'
        eight_digit_sic_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Eight Digit Sic Description
          description: Eight-digit SIC description to filter by
          example: Eating places
        four_digit_sic_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Four Digit Sic Code
          description: Four-digit SIC code to filter by
          example: '5812'
        four_digit_sic_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Four Digit Sic Description
          description: Four-digit SIC description to filter by
          example: Eating places
        two_digit_sic_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Two Digit Sic Code
          description: Two-digit SIC code to filter by
          example: '58'
        two_digit_sic_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Two Digit Sic Description
          description: Two-digit SIC description to filter by
          example: Eating and Drinking Places
        naics_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Naics Code
          description: NAICS code to filter by
          example: '722513'
        naics_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Naics Description
          description: NAICS description to filter by
          example: Limited-Service Restaurants
        industry:
          anyOf:
            - type: string
            - type: 'null'
          title: Industry
          description: Industry to filter by
          example: Financial Services
        keywords:
          anyOf:
            - type: string
            - type: 'null'
          title: Keywords
          description: Keywords to filter by (comma-separated)
          example: coffee, bakery
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: Company email address to filter by
          example: info@company.com
        number_employees:
          anyOf:
            - type: string
            - type: 'null'
          title: Number Employees
          description: Number of employees to filter by
          example: '25'
        annual_revenue:
          anyOf:
            - type: string
            - type: 'null'
          title: Annual Revenue
          description: Annual revenue to filter by
          example: '5000000'
        time_in_business:
          anyOf:
            - type: string
            - type: 'null'
          title: Time In Business
          description: Time in business to filter by
          example: '3'
        linkedin_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Url
          description: LinkedIn URL to filter by
          example: https://www.linkedin.com/company/example
        facebook_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Facebook Url
          description: Facebook URL to filter by
          example: https://www.facebook.com/example
        twitter_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Twitter Url
          description: Twitter URL to filter by
          example: https://www.twitter.com/example
        instagram_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Instagram Url
          description: Instagram URL to filter by
          example: https://www.instagram.com/example
        crunchbase_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Crunchbase Url
          description: Crunchbase URL to filter by
          example: https://www.crunchbase.com/company/example
        bbb_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Bbb Url
          description: BBB URL to filter by
          example: https://www.bbb.org/company/example
        number_locations:
          anyOf:
            - type: string
            - type: 'null'
          title: Number Locations
          description: Number of locations to filter by
          example: '5'
        financing_partners:
          anyOf:
            - type: string
            - type: 'null'
          title: Financing Partners
          description: Financing partners to filter by
          example: Wells Fargo
        include_fields:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Include Fields
          description: Field or list of fields to include in each record in the response
          example:
            - company_id
            - company_name
            - url
        page:
          type: integer
          minimum: 1
          title: Page
          description: >-
            Page number of results to return. Must be greater than or equal to
            1.
          default: 1
          example: 1
        per_page:
          type: integer
          maximum: 50
          title: Per Page
          description: Number of results per page. Maximum is 50.
          default: 50
          example: 50
      type: object
      title: CompaniesRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      scheme: bearer

````