> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapin.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Company Match
> This operation allows you to find a company from its domain name. It returns company information as the response. This operation consumes 2 credits (or 1 credit if served from cache).
If we find the profile in our cache within your specified duration, we serve
it instantly at **1 credit**. This is a 50% savings on the standard
price.
If the profile isn't cached, we perform a **live scrape** to get fresh data.
This costs the standard **2 credits**.
## Request Tracking & Reporting
**Found incorrect or missing data?** Visit your [API
Logs](https://app.scrapin.io/api-logs) to view all requests and report issues
directly from the web interface.
**How to report an issue:**
1. Go to [app.scrapin.io/api-logs](https://app.scrapin.io/api-logs)
2. Find the request you want to report in the logs table
3. Click the **"Report"** button in the Actions column
4. Select the issue type and add a description
The `request_id` helps our team investigate and resolve issues quickly. All
enrichment requests are automatically logged for your convenience.
## OpenAPI
````yaml GET /v1/enrichment/company/domain
openapi: 3.0.0
info:
title: ScrapIn API
version: 1.1.0
servers:
- url: https://api.scrapin.io
security:
- apiKey: []
tags:
- name: Person
- name: Company
- name: Job
- name: Workspaces
paths:
/v1/enrichment/company/domain:
get:
tags:
- Company
summary: Company Match
description: >-
This operation allows you to find a company from its domain name. It
returns company information as the response. This operation consumes 2
credits (or 1 credit if served from cache).
operationId: CompanyMatch
parameters:
- name: domain
in: query
schema:
type: string
description: >-
This required parameter is a string. It represents the domain name
of the company to query.
required: true
- name: cacheDuration
in: query
schema:
type: string
description: >-
Optional parameter to enable caching. Accepts duration strings like
'4h', '2d', '1w', '2mo', '1y'. We use the
[parse-duration](https://www.npmjs.com/package/parse-duration)
library internally to parse these values. If the profile is found in
cache within this duration, only 1 credit is consumed. Otherwise,
fresh data is scraped for 2 credits.
required: false
example: 2d
responses:
'200':
description: The endpoint returns information about the company.
content:
application/json:
schema:
$ref: '#/components/schemas/CompanySearch'
examples:
CompanyFound:
$ref: '#/components/examples/CompanyFound'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/PaymentRequired'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
components:
schemas:
CompanySearch:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates success or failure of api request.
- $ref: '#/components/schemas/RateLimitInfo'
- type: object
properties:
metadata:
type: object
properties:
source:
type: string
enum:
- cache
- fresh
description: >-
Indicates whether the data was served from cache or freshly
scraped.
request_id:
type: string
description: Unique identifier for this request.
updatedAt:
type: string
format: date-time
description: >-
ISO 8601 timestamp indicating when the cached data was last
updated. This field is only present when source is 'cache'.
company:
oneOf:
- $ref: '#/components/schemas/Company'
- type: boolean
enum:
- false
RateLimitInfo:
type: object
properties:
credits_consumed:
type: number
description: Represents the number of credits consumed by this query.
credits_left:
type: number
description: >-
Represents the usable credits available for the user account after
this query.
rate_limit_left:
type: number
description: >-
Represents the usable daily request limit available for the user
account after this query.
daily_rate_limit_left:
type: number
description: >-
Represents the usable daily request limit available for the user
account after this query.
minute_rate_limit_left:
type: number
description: >-
Represents the usable minute request limit available for the user
account after this query.
next_minute_rate_limit_reset:
type: string
description: >-
Represents the next minute rate limit reset for the user account
after this query. Datetime in ISO 8601 format (e.g.,
2025-11-14T14:34:43.000Z).
quotas:
type: object
description: >-
Structured quota information for the user account. Provides the same
data as the flat fields above in a more organized format.
properties:
credits:
type: object
description: Credit usage information for the user account.
properties:
total:
type: number
description: Total credits available on the account.
used:
type: number
description: Total credits used on the account.
left:
type: number
description: Remaining credits available on the account.
daily_rate_limit:
type: object
description: Daily rate limit information for the user account.
properties:
limit:
type: number
description: Maximum number of requests allowed per day.
used:
type: number
description: Number of requests used today.
left:
type: number
description: Remaining requests allowed today.
next_reset:
type: string
description: >-
Next daily rate limit reset time in ISO 8601 format (e.g.,
2026-01-28T00:00:00.000Z).
minute_rate_limit:
type: object
description: Per-minute rate limit information for the user account.
properties:
limit:
type: number
description: Maximum number of requests allowed per minute.
used:
type: number
description: Number of requests used in the current minute window.
left:
type: number
description: Remaining requests allowed in the current minute window.
next_reset:
type: string
description: >-
Next minute rate limit reset time in ISO 8601 format (e.g.,
2026-01-27T14:32:45.000Z).
Company:
type: object
properties:
description:
type: string
employeeCount:
type: number
employeeCountRange:
type: object
properties:
start:
type: number
end:
type: number
followerCount:
type: number
headquarter:
type: object
properties:
city:
type: string
country:
type: string
geographicArea:
type: string
postalCode:
type: string
street1:
type: string
street2:
type: string
industry:
type: string
linkedInId:
type: string
linkedInUrl:
type: string
name:
type: string
specialities:
type: array
items:
type: string
tagline:
type: string
universalName:
type: string
websiteUrl:
type: string
ErrorResponseSchema:
type: object
properties:
success:
type: boolean
enum:
- false
title:
type: string
msg:
type: string
examples:
CompanyFound:
summary: Company Found
value:
success: true
credits_consumed: 2
credits_left: 90000.5
rate_limit_left: 19000
daily_rate_limit_left: 19000
minute_rate_limit_left: 499
next_minute_rate_limit_reset: '2024-01-15T10:31:00Z'
quotas:
credits:
total: 10000
used: 1234
left: 8766
daily_rate_limit:
limit: 5000
used: 150
left: 4850
next_reset: '2024-10-31T12:46:00.000Z'
minute_rate_limit:
limit: 500
used: 12
left: 488
next_reset: '2024-10-31T12:46:00.000Z'
metadata:
source: fresh
request_id: 000xcc2a-829a-4200-9704-f6f9cf9a23de
company:
linkedInId: '71234370'
name: Data company
universalName: data-company
linkedInUrl: https://www.social.com/company/12345678
employeeCount: 14
followerCount: 806
employeeCountRange:
start: 11
end: 50
websiteUrl: https://data.com
tagline: We Provide Data for company
description: >-
Our mission is to provide the most accurate and reliable web data,
empowering AI applications to thrive in this new era of computing.β
industry: Software Development
phone: null
specialities:
- Lead Generation
- Lead Qualification
- Market Search
- Competitor analysis
- CRM enrichment
headquarter:
city: Paris
country: FR
postalCode: '7500'
geographicArea: Γle-de-France
street1: 3, Paris street
street2: mailbox 032
logo: >-
https://media.licdn.com/dms/image/v2/D4E0BAQGj-Nfob0e55g/company-logo_400_400/company-logo_400_400/0/1702166267344/data_logo?e=1756339200&v=beta&t=99eMIcY7IX2cLI-YkJOBdfg16aCwmd7Tpk8BrSXaJHg
foundedOn:
year: 2020
fundingData: null
backgroundUrl: >-
https://media.licdn.com/dms/image/v2/D4E1BAQEldpeB551LZA/company-background_10000/company-background_10000/0/1678715803339/data_cover?e=1751288400&v=beta&t=gA-h6dpu8MRhpok9BoeVM5A0aPxGcM-9O7BqdOG8uRM
NoApiKey:
summary: No Api Key
value:
success: false
title: An error has occurred π
msg: The API Key is missing
MissingEmail:
summary: Missing Email
value:
success: false
title: An error has occurred π
msg: The email is missing
InvalidEmail:
summary: Invalid Email
value:
success: false
title: An error has occurred π
msg: The email has the wrong format
InvalidApiKey:
summary: Invalid Api Key
value:
success: false
title: Unauthorized
msg: API Key is invalid
PaymentRequired:
summary: Payment Required
value:
success: false
title: You don't have enough credits on your account π°
msg: You have to upgrade to continue
PageNotFound:
summary: Data Not Found
value:
success: false
title: Not Found
msg: No data found
ServerError:
summary: Server Error
value:
success: false
title: Internal Server Error
msg: An internal server error has occurred
responses:
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseSchema'
examples:
NoApiKey:
$ref: '#/components/examples/NoApiKey'
MissingEmail:
$ref: '#/components/examples/MissingEmail'
InvalidEmail:
$ref: '#/components/examples/InvalidEmail'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseSchema'
examples:
InvalidApiKey:
$ref: '#/components/examples/InvalidApiKey'
PaymentRequired:
description: Insufficient Account Balance
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseSchema'
examples:
PaymentRequired:
$ref: '#/components/examples/PaymentRequired'
NotFound:
description: Data Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseSchema'
examples:
PageNotFound:
$ref: '#/components/examples/PageNotFound'
ServerError:
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseSchema'
examples:
ServerError:
$ref: '#/components/examples/ServerError'
securitySchemes:
apiKey:
name: apikey
in: query
type: apiKey
description: >-
This required parameter is a string. It represents the APIKEY obtained
from the developer dashboard.
You must use it in the query string of your request as
?apikey=YOUR_API_KEY or in the headers as x-api-key: YOUR_API_KEY
````