> ## 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.
# Person Profile Match
> This operation allows you to match a single person profile from various parameters. It returns profile data with credits and rate limit information. This operation consumes 2 credits (or 1 credit if served from cache).
**Caching Available:** Use the optional `cacheDuration` parameter to enable
caching and reduce costs. Cache hits consume only **1 credit** instead of 2
credits. See the request parameters below for details.
## How Caching Works
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**.
**Complete History:** The `positionHistory`, `educationHistory`, and `certificationHistory` fields return all positions, education entries, and certifications available on the profile.
## 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 POST /v1/enrichment/match
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/match:
post:
tags:
- Person
summary: Match Profile
description: >-
This operation allows you to match a single person profile from various
parameters. It returns profile data with credits and rate limit
information. This operation consumes 2 credits (or 1 credit if served
from cache).
operationId: MatchProfile
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
firstName:
type: string
description: >-
This optional parameter is a string. It represents the first
name to body.
lastName:
type: string
description: >-
This optional parameter is a string. It represents the last
name to body.
companyDomain:
type: string
description: >-
This optional parameter is a string. It represents the
company domain/URL to body. *You can use current or any
previous company to that person.
companyName:
type: string
description: >-
This optional parameter is a string. It represents the
company name to body. *You can use current or any previous
company to that person.
email:
type: string
description: >-
This optional parameter is a string. It represents the email
to body.
cacheDuration:
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.
example: 2d
includes:
type: object
additionalProperties: false
description: >-
This required parameter is an object. It specifies which
additional data to include in the response.
properties:
includeCompany:
type: boolean
description: Include company information in the response.
includeSummary:
type: boolean
description: Include summary information in the response.
includeFollowersCount:
type: boolean
description: Include followers count in the response.
includeCreationDate:
type: boolean
description: Include creation date in the response.
includeSkills:
type: boolean
description: Include skills information in the response.
includeLanguages:
type: boolean
description: Include languages information in the response.
includeExperience:
type: boolean
description: Include experience information in the response.
includeEducation:
type: boolean
description: >-
Include education and schools information in the
response.
includeCertifications:
type: boolean
description: Include certifications in the response.
required:
- includes
responses:
'200':
description: The endpoint returns profile information.
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileResponseV1'
examples:
ProfileFound:
$ref: '#/components/examples/ProfileFoundV1'
'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:
ProfileResponseV1:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates success or failure of api request.
- $ref: '#/components/schemas/RateLimitInfo'
- type: object
properties:
person:
$ref: '#/components/schemas/PersonProfile'
company:
oneOf:
- $ref: '#/components/schemas/Company'
- type: boolean
enum:
- false
metadata:
$ref: '#/components/schemas/RequestMetadata'
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).
PersonProfile:
type: object
properties:
publicIdentifier:
type: string
description: Public identifier of the person
linkedInIdentifier:
type: string
description: Social identifier of the person
memberIdentifier:
type: string
description: Member identifier of the person
linkedInUrl:
type: string
description: Social URL of the person
firstName:
type: string
description: First name of the person
lastName:
type: string
description: Last name of the person
headline:
type: string
description: Professional headline of the person
location:
$ref: '#/components/schemas/PersonLocation'
photoUrl:
type: string
description: URL to the person's profile photo
backgroundUrl:
type: string
description: URL to the person's background image
openToWork:
type: boolean
description: Indicates if the person is open to work
premium:
type: boolean
description: Indicates if the person has a premium Social account
pronoun:
type: string
description: Preferred pronoun of the person
showVerificationBadge:
type: boolean
description: Indicates if the person shows verification badge
summary:
type: string
description: >-
A summary/about section of the person's profile. Included when
'summary' is in the includes parameter.
creationDate:
$ref: '#/components/schemas/CreationDate'
description: >-
The date when the person's profile was created. Included when
'creationDate' is in the includes parameter.
followerCount:
type: integer
description: >-
Number of followers the person has. Included when 'followersCount'
is in the includes parameter.
connectionsCount:
type: integer
description: >-
Number of connections the person has. Included when
'connectionsCount' is in the includes parameter.
currentPosition:
$ref: '#/components/schemas/CurrentPosition'
description: >-
Current position of the person. Returns the most recent active
position.
positions:
$ref: '#/components/schemas/PositionsData'
description: >-
Work experience positions of the person. Included when 'positions'
is in the includes parameter.
schools:
$ref: '#/components/schemas/EducationsData'
description: >-
Education history of the person. Included when 'schools' is in the
includes parameter.
skills:
type: array
items:
type: string
description: List of skills. Included when 'skills' is in the includes parameter.
languages:
type: array
items:
type: string
description: >-
List of languages spoken. Included when 'languages' is in the
includes parameter.
languagesWithProficiency:
type: array
items:
type: object
properties:
language:
type: string
proficiency:
type: string
description: >-
List of languages spoken with proficiency. Included when
'languagesWithProficiency' is in the includes parameter.
recommendations:
type: object
properties:
recommendationsCount:
type: integer
recommendationHistory:
type: array
items:
type: object
properties:
caption:
type: string
description:
type: string
authorFullname:
type: string
authorUrl:
type: string
description: Array of recommendation entries
description: >-
List of recommendations. Included when 'recommendations' is in the
includes parameter. Limited to the last 2 recommendations.
certifications:
$ref: '#/components/schemas/CertificationsData'
description: >-
Certifications obtained by the person. Included when
'certifications' is in the includes parameter.
testScores:
type: object
properties:
testScoresCount:
type: integer
testScoreHistory:
type: array
description: >-
List of test scores. Included when 'testScores' is in the includes
parameter.
volunteeringExperiences:
type: object
properties:
volunteeringExperiencesCount:
type: integer
volunteeringExperienceHistory:
type: array
description: >-
List of volunteering experiences. Included when
'volunteeringExperiences' is in the includes parameter.
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
RequestMetadata:
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'.
executionTimeMs:
type: integer
description: The execution time in milliseconds for this request.
ErrorResponseSchema:
type: object
properties:
success:
type: boolean
enum:
- false
title:
type: string
msg:
type: string
PersonLocation:
type: object
properties:
city:
type: string
description: City where the person is located
state:
type: string
description: State where the person is located
country:
type: string
description: Country where the person is located
countryCode:
type: string
description: Country code where the person is located
CreationDate:
type: object
description: Represents the creation date of a profile
properties:
month:
type: integer
description: Month of creation (1-12)
year:
type: integer
description: Year of creation
CurrentPosition:
type: object
description: Current active position of the person
properties:
title:
type: string
description: Job title or position name
description:
type: string
description: Description of the position or role
contractType:
type: string
description: Type of employment contract
companyName:
type: string
description: Name of the company
linkedInId:
type: string
description: Social identifier of the company
linkedInUrl:
type: string
format: uri
description: Social URL of the company
companyLocation:
type: string
description: Location of the company
companyLogo:
type: string
format: uri
description: URL to the company logo image
startEndDate:
type: object
properties:
start:
type: object
properties:
month:
type: integer
description: Start month (1-12)
year:
type: integer
description: Start year
end:
type: object
nullable: true
properties:
month:
type: integer
description: End month (1-12)
year:
type: integer
description: End year
description: End date, null if current position
PositionsData:
type: object
description: Container for work experience positions
properties:
positionsCount:
type: integer
description: Total number of positions
positionHistory:
type: array
items:
$ref: '#/components/schemas/Position'
description: Array of position entries
EducationsData:
type: object
description: Container for education history
properties:
educationsCount:
type: integer
description: Total number of education entries
educationHistory:
type: array
items:
$ref: '#/components/schemas/School'
description: Array of education entries
CertificationsData:
type: object
description: Container for certifications
properties:
certificationsCount:
type: integer
description: Total number of certifications
certificationHistory:
type: array
items:
$ref: '#/components/schemas/Certification'
description: Array of certification entries
Position:
type: object
properties:
title:
type: string
description: Job title or position name
companyName:
type: string
description: Name of the company
description:
type: string
description: Description of the position or role
startEndDate:
$ref: '#/components/schemas/StartEndDate'
description: Start and end dates of the position
companyLogo:
type: string
format: uri
description: URL to the company logo image
linkedInUrl:
type: string
format: uri
description: Social URL of the company
linkedInId:
type: string
description: Social identifier of the company
School:
type: object
properties:
degreeName:
type: string
description: Name of the degree or program
fieldOfStudy:
type: string
description: Field of study or specialization
description:
type: string
description: Description of the degree or program
linkedInUrl:
type: string
format: uri
description: Social URL of the school
schoolLogo:
type: string
format: uri
description: URL to the school logo image
schoolName:
type: string
description: Name of the educational institution
startEndDate:
$ref: '#/components/schemas/StartEndDate'
description: Start and end dates of the education period
Certification:
type: object
properties:
name:
type: string
description: Name of the certification
organizationName:
type: string
description: Name of the organization that issued the certification
organizationUrl:
type: string
format: uri
description: Social URL of the organization
issuedDate:
type: string
description: Date when the certification was issued
StartEndDate:
type: object
properties:
start:
type: string
format: date-time
description: Start date of the position in ISO 8601 format
end:
type: string
format: date-time
nullable: true
description: >-
End date of the position in ISO 8601 format, null if current
position
examples:
ProfileFoundV1:
summary: Person Profile Extracted
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: '2025-07-24T12:11:01.000Z'
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
person:
publicIdentifier: michael
linkedInIdentifier: ACoAABTEFqYBfjGaiNAy5ITKaPacBEBDdR1Srhs
memberIdentifier: '248295112'
linkedInUrl: https://www.social.com/in/michael
firstName: Michael
lastName: Davis
headline: VP Sales Scrapin.io - B2B Data for AI
location:
city: London
state: England
country: United Kingdom
countryCode: GB
summary: >-
I'm a software engineer with a passion for building scalable and
efficient systems.
photoUrl: >-
https://media.licdn.com/dms/image/v2/D4E03AQG5S0X4QKtN5A/profile-displayphoto-shrink_200_200/B4EZRgQ6wZGYAY-/0/1736781836053?e=1756339200&v=beta&t=phxC3jRwoDG_zQ8QY4Iu6OduHPUM-abbrEHkJZPP9fM
backgroundUrl: >-
https://media.licdn.com/dms/image/v2/C4E16AQGba4BhpCykTA/profile-displaybackgroundimage-shrink_350_1400/profile-displaybackgroundimage-shrink_350_1400/0/1516880563413?e=1756339200&v=beta&t=fdimLlwIIQEke73CfLZWvq0T367YxZajvtmMwynSIiU
openToWork: false
premium: true
showVerificationBadge: true
creationDate:
month: 6
year: 2014
followerCount: 3735
connectionsCount: 650
currentPosition:
title: VP of Sales
description: B2B Data for AI +
contractType: Full-time
companyName: ScrapIn
linkedInId: '100602385'
linkedInUrl: https://www.social.com/company/scrapin-api/
companyLocation: London, England, United Kingdom
companyLogo: >-
https://media.licdn.com/dms/image/v2/D4E0BAQF-Z-m2ZKv6qQ/company-logo_200_200/B4EZcRELezHcAM-/0/1748337998127/scrapin_api_logo?e=1756339200&v=beta&t=GjTJ9cgDP2iBYJCx8GxXEg8V2hZjnNBOtvXe58eiqJ0
startEndDate:
start:
month: 1
year: 2024
end: null
positions:
positionsCount: 10
positionHistory:
- title: VP of Sales
companyName: ScrapIn
description: B2B Data for AI +
startEndDate:
start:
month: 1
year: 2024
end: null
companyLogo: >-
https://media.licdn.com/dms/image/v2/D4E0BAQF-Z-m2ZKv6qQ/company-logo_200_200/B4EZcRELezHcAM-/0/1748337998127/scrapin_api_logo?e=1756339200&v=beta&t=GjTJ9cgDP2iBYJCx8GxXEg8V2hZjnNBOtvXe58eiqJ0
linkedInUrl: https://www.social.com/company/100602385/
linkedInId: '100602385'
- title: Co-Founder & CEO
companyName: LukaHQ
companyLocation: London, England, United Kingdom
description: AI accounting for the mid-market
startEndDate:
start:
month: 1
year: 2023
end:
month: 12
year: 2023
companyLogo: >-
https://media.licdn.com/dms/image/v2/C4E0BAQHUbWeUxkGCfw/company-logo_400_400/company-logo_400_400/0/1677251426049?e=1756339200&v=beta&t=qQuFuWn2EsyNX-kqmN166nzxW-DxXD66cPph71e3F7g
linkedInUrl: https://www.social.com/company/93128145/
linkedInId: '93128145'
- title: Co-Founder & CEO
companyName: Telleroo
companyLocation: London
description: >-
Leading SME payments platform for bill and payroll payments in
the UK 💪
startEndDate:
start:
month: 4
year: 2016
end:
month: 10
year: 2020
companyLogo: >-
https://media.licdn.com/dms/image/v2/D4E0BAQFg65EK-q7guw/company-logo_100_100/B4EZdkSAIuHsAQ-/0/1749734130592/telleroo_logo?e=1756339200&v=beta&t=4rKb656EJBg9K3ewqcB0_Gjt9Z2roK_8B5ABHX7Qvjg
linkedInUrl: https://www.social.com/company/10820464/
linkedInId: '10820464'
schools:
educationsCount: 2
educationHistory:
- degreeName: Bachelor of Arts in Business (B.A.)
fieldOfStudy: Management & Economics
linkedInUrl: https://www.social.com/company/628151/
schoolLogo: >-
https://media.licdn.com/dms/image/v2/C4E0BAQHWOueQUCYM2w/company-logo_400_400/company-logo_400_400/0/1631321484128?e=1756339200&v=beta&t=D_3g7F10ojzXtq-dcHxFAvMR8ANmJN_rNb3ETPf9THM
schoolName: MCI | The Entrepreneurial School®
startEndDate:
start:
month: 1
year: 2011
end:
month: 1
year: 2015
- degreeName: International Studies - Doing Business in Brazil
fieldOfStudy: null
linkedInUrl: https://www.social.com/company/8175/
schoolLogo: >-
https://media.licdn.com/dms/image/v2/C4D0BAQFtDwxOTmj18Q/company-logo_400_400/company-logo_400_400/0/1657633907178/fgv_logo?e=1756339200&v=beta&t=Dfl7ag8K3dK8LeB2f_1AvexYw3QNaFWWsTK5KBDfIhk
schoolName: FGV - Fundação Getulio Vargas
startEndDate:
start:
month: 1
year: 2014
end:
month: 1
year: 2014
skills:
- Bubble.io
- Changemaker
- Decisionmaker
- Big Picture View
- Team Motivation
- Public Speaking
- Storytelling
- Social Media Marketing
- Portfolio Management
- Assetmanagement
- Financial Analysis
- Asset Allocation
- FinTech
- Banking
- Leadership
- Investmentbank
- Financial Modeling
- Capital Markets
- Creative Strategy
- Corporate Finance
- Systematic Thinking
- Experimental Design
- Bloomberg
- WordPress
- Podcasting
- Content Marketing
- Business Model Innovation
- Email Marketing
- Web Design
- Blogging
- Tech Application
- Jack of all trades
- Google Apps
- Google Docs
- Trading
- Investment Strategies
- Microsoft Excel
- Commodity
- Fixed Income
- Equities
languages:
- Deutsch
- English
languagesWithProficiency:
- language: Chinese
proficiency: Native or bilingual proficiency
- language: English
proficiency: Full professional proficiency
- language: French
proficiency: Native or bilingual proficiency
- language: Japanese
proficiency: Elementary proficiency
recommendations:
recommendationsCount: 2
recommendationHistory:
- caption: May 14, 2025, Lucas and David studied together
description: >-
I had the opportunity to work with David, both at school and
at work. In an academic environment, we worked together on
several projects, in a very dynamic and effective way. We have
different profiles with some similarities, and I saw him
evolving in a complex professional environment and improving
his skills while sharing his knowledge with me.
We also travelled together, and I discoverd a really curious
and organized person, which are important qualities to work
together in a team.
authorFullname: Lucas Nascimento
authorUrl: https://www.linkedin.com/in/lucasnascimento
- caption: May 12, 2025, Lisa and David studied together
description: >-
David and I spent two years studying together at ESILV. We
worked on several common projects where he showed his great
technical skills that helped the group a lot. David is
curious, pragmatic and proactive. I also spent 3 weeks with
him at Shanghai Normal University where he helped me with
chinese course. I would definitely love to work with partners
like David in the future.
authorFullname: Lisa Lopes
authorUrl: https://www.linkedin.com/in/lisalopes
certifications:
certificationsCount: 1
certificationHistory:
- name: Trading Certificate Frankfurt Stock Exchange
organizationName: Deutsche Börse
organizationUrl: https://www.social.com/company/163430/
issuedDate: Issued May 2012
testScores:
testScoresCount: 0
testScoreHistory: []
volunteeringExperiences:
volunteeringExperiencesCount: 0
volunteeringExperienceHistory: []
company:
linkedInId: '100602385'
name: ScrapIn
universalName: scrapin-api
linkedInUrl: https://www.social.com/company/100602385
employeeCount: 12
followerCount: 1030
employeeCountRange:
start: 11
end: 50
websiteUrl: https://www.scrapin.io/
tagline: Powering AI products with Live B2B Data
description: >-
ScrapIn provides live B2B data with all necessary context you need
to build a full-featured, scalable AI tool — We hide any data
scraping complexity and infrastructure. Let us handle data
collection and you focus on building.
industry: Software Development
phone: null
specialities: []
headquarter:
city: Paris
country: FR
postalCode: '75000'
geographicArea: null
street1: null
street2: null
logo: >-
https://media.licdn.com/dms/image/v2/D4E0BAQF-Z-m2ZKv6qQ/company-logo_200_200/B4EZcRELezHcAM-/0/1748337998127/scrapin_api_logo?e=1756339200&v=beta&t=GjTJ9cgDP2iBYJCx8GxXEg8V2hZjnNBOtvXe58eiqJ0
foundedOn:
year: 2020
fundingData: null
backgroundUrl: >-
https://media.licdn.com/dms/image/v2/D4E1BAQEnSV0NjtZSXA/company-background_200/B4EZcRNJq.HYAc-/0/1748340349995/scrapin_api_cover?e=1753966800&v=beta&t=PdbNUkpicYwyp6cn9tri20MLicIO_9ASua8ZUsJm5cg
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
````