Make competitive insights your unfair advantage.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/birdeye-competitor-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Birdeye Competitor API
version: '1.0'
description: 'Operations tagged Competitor across 2 of this provider''s published API definitions: birdeye-birdeye-api-openapi.yml, birdeye-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.birdeye.com
description: Production
- url: https://api.birdeye.com/resources
tags:
- name: Competitor
description: Make competitive insights your unfair advantage.
paths:
/v1/business/{EnterpriseBusinessNumber}/child:
get:
summary: Get Competitor Business
operationId: get-competitor-business
tags:
- Competitor
parameters:
- name: EnterpriseBusinessNumber
in: path
required: true
description: Enterprise Business id.
schema:
type: string
example: '231123123'
- name: isCompetitor
in: query
required: true
description: True for get competitor business of Enterprise Business and False for get Child Business of Enterprise Business.
schema:
type: boolean
example: 'true'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/{EnterpriseCompetitorBusinessId}/child:
get:
summary: Get Competitor Child Business
operationId: get-competitor-child-business
tags:
- Competitor
parameters:
- name: isCompetitor
in: query
required: true
description: True for get competitor business of Enterprise Business and False for get Child Business of Enterprise Business.
schema:
type: boolean
example: 'true'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/business/{businessId}/competitors:
get:
summary: Get Business Competitors
operationId: get-business-competitors
tags:
- Competitor
parameters:
- name: businessId
in: path
required: true
description: Account Business Number.
schema:
type: string
example: '986031488'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/signup/competitor/{businessNumber}:
post:
summary: Create New Competitor Enterprise
operationId: create-new-competitor-enterprise
tags:
- Competitor
parameters:
- name: businessNumber
in: path
required: true
description: Account Business Number.
schema:
type: string
example: '169744180007807'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
businessName:
type: string
userEmailId:
type: string
countryCode:
type: string
phone:
type: string
zip:
type: string
competitorId:
type: string
type:
type: string
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/signup/competitor/{businessId}:
post:
summary: Create New Child Business in Competitor Enterprise
operationId: create-new-child-business-in-competitor-enterprise
tags:
- Competitor
parameters:
- name: businessId
in: path
required: true
description: Account Business Number.
schema:
type: string
example: '986031488'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/aggregation/competitor/{compAccountId}/{businessNumber}:
post:
summary: Add new Competitor Aggregation URL
operationId: add-new-competitor-aggregation-url
tags:
- Competitor
parameters:
- name: businessNumber
in: path
required: true
description: Id of the business.
schema:
type: number
example: '169744180007807'
- name: compAccountId
in: path
required: true
description: Competitor Account Id.
schema:
type: number
example: '234567'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
sourceAlias:
type: string
url:
type: string
required:
- sourceAlias
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/review/businessId/{CompetitorEnterpriseBusinessId}:
post:
summary: Get Competitor Reviews
operationId: get-competitor-reviews
tags:
- Competitor
parameters:
- name: sindex
in: query
required: true
description: Start index of the reviews.
schema:
type: integer
example: '10'
- name: count
in: query
required: true
description: Number of reviews to query.
schema:
type: integer
example: '30'
- name: isCompetitor
in: query
required: true
description: True for Competitor Review.
schema:
type: boolean
example: 'false'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1228
message: Invalid updated to date. Allowed format is MM/dd/yyyy
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
fromDate:
type: string
toDate:
type: string
updateFromDate:
type: string
updateToDate:
type: string
sources:
type: string
ratings:
type: array
searchStr:
type: string
subBusinessIds:
type: array
statuses:
type: array
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/competitors/competitive-insight/categories/{businessNumber}:
post:
summary: Get Score
operationId: get-score
tags:
- Competitor
parameters:
- name: businessNumber
in: path
required: true
description: Account Business Number.
schema:
type: string
example: '169744180007807'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
sourceType:
type: string
sources:
type: array
timePeriodSelected:
type: string
startDate:
type: string
endDate:
type: string
competitors:
type: array
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/competitors/competitive-insight/themes/{businessNumber}:
post:
summary: Get Theme Statistics
operationId: get-theme-statistics
tags:
- Competitor
parameters:
- name: businessNumber
in: path
required: true
description: Account Business Number.
schema:
type: string
example: '169744180007807'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
sourceType:
type: string
sources:
type: array
timePeriodSelected:
type: string
startDate:
type: string
endDate:
type: string
competitors:
type: array
topThm:
type: number
orderBy:
type: string
sentiment:
type: number
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
/v1/competitors/competitive-insight/keywords/{businessNumber}:
post:
summary: Get Keyword Statistics
operationId: get-keyword-statistics
tags:
- Competitor
parameters:
- name: businessNumber
in: path
required: true
description: Account Business Number.
schema:
type: string
example: '169744180007807'
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
example:
code: 1167
message: API key is missing
requestBody:
required: true
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
sourceType:
type: string
sources:
type: array
timePeriodSelected:
type: string
startDate:
type: string
endDate:
type: string
competitors:
type: array
topKW:
type: number
topAd:
type: number
orderBy:
type: string
sentiment:
type: number
security:
- apiKey: []
servers:
- url: https://api.birdeye.com
description: Production
components:
schemas:
1228Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1228
message: Invalid updated to date. Allowed format is MM/dd/yyyy
1167Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1167
message: API key is missing
1011Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1011
message: Business id is invalid
1187Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1187
message: Invalid to date. Allowed format is "MM/dd/yyyy".
Apiary_getBusinessCompetitors_Response200:
type: array
items:
type: object
properties:
enterpriseId:
type: number
description: Enterprise Business Number.
enterpriseName:
type: string
description: Enterprise Name.
businessCompetitors:
type: array
items:
type: object
properties:
businessId:
type: number
description: Competitor Business Number.
name:
type: string
description: Competitor Business Name.
location:
type: object
properties:
address1:
type: string
description: Address of the business.
address2:
type: string
description: Address of the business.
city:
type: string
description: City (Max 1000 character long).
state:
type: string
description: State (2 character state code).
countryCode:
type: string
description: Country Code (2 character country code).
zip:
type: string
description: Zip Code.
countryName:
type: string
description: Country Name (2 character country code).
lat:
type: string
description: Latitude.
lng:
type: string
description: Longitude.
description: Address details
description: List of business competitors
Apiary_getKeywordStatistics_Response200:
type: object
properties:
id:
type: number
example: 119468
description: Business Id
name:
type: string
example: Social Stress
description: Name of Enterprise
keywords:
type: array
items: {}
description: List of keywords.
ct:
type: number
example: 27159
description: Count.
avgScr:
type: number
example: 1
description: Average Score.
keywordStats:
type: array
items:
type: object
properties:
keyword:
type: string
description: Keyword
occurences:
type: number
description: Occurences
score:
type: number
description: Score
scr:
type: number
description: Scr.
negKWAdjectives:
type: array
items:
type: object
properties:
adjective:
type: string
description: Adjectives
occurences:
type: number
description: Occurences
prcnt:
type: number
description: Percentage
avgScore:
type: number
description: Average Score
description: Negative keyword details
competitors:
type: array
items:
type: object
properties:
id:
type: number
description: Business Id
name:
type: string
description: Name of Enterprise
keywords:
type: array
items: {}
description: List of keywords.
ct:
type: number
description: Count.
avgScr:
type: number
description: Average Score.
keywordStats:
type: array
items:
type: object
properties:
keyword:
type: string
description: Keyword
occurences:
type: number
description: Occurences
score:
type: number
description: Score
scr:
type: number
description: Scr.
negKWAdjectives:
type: array
items:
type: object
properties:
adjective:
type: string
description: Adjectives
occurences:
type: number
description: Occurences
prcnt:
type: number
description: Percentage
avgScore:
type: number
description: Average Score
description: Negative keyword details
description: Competitor details
Apiary_addNewCompetitorAggregationUrl_Request:
type: object
properties:
sourceAlias:
type: string
description: Source alias.
url:
type: string
description: Source url to be added.
required:
- sourceAlias
- url
example:
sourceAlias: 'citysearch '
url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco
1163Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1163
message: Invalid start index value
Apiary_createNewChildBusinessInCompetitorEnterprise_Response200:
type: object
properties:
competitorId:
type: number
example: 100037739
description: Enterprise Competitor Business ID.
templateid:
type: number
description: Template Id.
isAggregationRequired:
type: number
example: 1
description: Is agrgegation required.
type:
type: string
example: Enterprise
description: Type.
businessNumber:
type: number
example: 169744180007807
description: Enterprise Competitor Business Number.
businessAlreadyPresent:
type: boolean
description: Is Business Already Present.
Apiary_getThemeStatistics_Request:
type: object
properties:
sourceType:
type: string
description: Type of source e.g. review [by default] or social.
sources:
type: array
description: Aggregation sources.
items: {}
timePeriodSelected:
type: string
description: 'For all time : all.'
startDate:
type: string
description: Date from which data has to be fetched[MM/DD/YYYY].
endDate:
type: string
description: Date until which data has to be fetched[MM/DD/YYYY].
competitors:
type: array
description: List of competitors
items:
type: object
properties:
competitorId:
type: number
description: Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API].
compAccountIds:
type: array
items: {}
description: Locations Ids of competitor account [compAccountIds in Child Business of Competitor API].
topThm:
type: number
description: Count of top Themes to be fetched.
orderBy:
type: string
description: 'Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"'
sentiment:
type: number
description: -1 = negative sentiment,
example:
sourceType: review
sources:
- google
- citysearch
startDate: 11/02/2020
endDate: 01/06/2021
competitors:
- competitorId: 530846
compAccountIds:
- 162426
- 144352
- competitorId: 720708
compAccountIds:
- 165432
topThm: 25
orderBy: occurrence
sentiment: -1
Apiary_addNewCompetitorAggregationUrl_Response200:
type: object
properties:
id:
type: number
description: Id of the created Aggregation.
sourceAlias:
type: string
description: Alias of the source.
sourceName:
type: string
description: Name of the source.
sourceUrl:
type: string
description: Url of the souce.
sourceId:
type: number
description: Id of the source.
compAccountId:
type: number
description: Competitor account id.
Body:
type: string
description: "{\n \"id\": 140179308,\n \"sourceId\": 2,\n \"compAccountId\": 1765,\n \"sourceUrl\": \"https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476\",\n \"sourceName\": \"Google\",\n \"thumbnailUrl\": \"source/icons/2.png\",\n \"backGroundColor\": \"#dd4b39\",\n \"textColor\": \"#ffffff\",\n \"userName\": null,\n \"password\": null,\n \"profileId\": null,\n \"reviewFormUrl\": \"https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476\",\n \"aggregationStatus\": 3,\n \"sourceAlias\": \"google\",\n \"disabledAggregation\": null,\n \"disabledAggregationReason\": null\n}"
1186Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1186
message: Invalid from date. Allowed format is "MM/dd/yyyy".
1161Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1161
message: Invalid API key
Apiary_getCompetitorReviews_Response200:
type: array
items:
type: object
properties:
reviewId:
type: number
description: Id of the review.
rating:
type: number
description: Overall rating for the review, in case of direct feedback and facebook recommendations it will be 0. For Facebook recommendations, value will be 1, Non recommended review will have value set as 0.
comments:
type: string
description: User comment.
reviewer:
type: object
properties:
firstName:
type: string
lastName:
type: string
nickName:
type: string
thumbnailUrl:
type: string
description: Thumbn
description: Reviewer details
sourceType:
type: string
description: Source of the review if it is an aggregated review.
reviewURL:
type: string
description: Review url
reviewDate:
type: string
description: Review posted date.
response:
type: string
description: Review response text.
responseDate:
type: string
description: Response date.
enableReply:
type: boolean
description: Whether a review reply is supported via Birdeye API or not.
customerId:
type: number
description: Customer's Id attributed with this review (if any).
extraParams:
type: object
description: Key value pair of custom field(s) associated with the customer attributed to the review (if any)
Apiary_createNewCompetitorEnterprise_Response200:
type: object
properties:
competitorId:
type: number
example: 100037739
description: Enterprise Competitor Business ID.
templateid:
type: number
description: Template Id.
isAggregationRequired:
type: number
example: 1
description: Is agrgegation required.
type:
type: string
example: Enterprise
description: Type.
businessNumber:
type: number
example: 169744180007807
description: Enterprise Competitor Business Number.
businessAlreadyPresent:
type: boolean
description: Is Business Already Present.
1227Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1227
message: Invalid updated from date. Allowed format is MM/dd/yyyy
1164Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1164
message: Invalid result count value
Apiary_getCompetitorBusiness_Response200:
type: array
items:
type: object
properties:
id:
type: number
description: Enterprise Competitor Business Number.
name:
type: string
description: Enterprise Competitor Business Name.
competitorId:
type: number
description: Enterprise Competitor Business ID.
alias:
type: string
description: Enterprise Competitor Business alias.
Apiary_getKeywordStatistics_Request:
type: object
properties:
sourceType:
type: string
description: Type of source e.g. review [by default] or social.
sources:
type: array
description: Aggregation sources.
items: {}
timePeriodSelected:
type: string
description: 'For all time : all.'
startDate:
type: string
description: Date from which data has to be fetched[MM/DD/YYYY].
endDate:
type: string
description: Date until which data has to be fetched[MM/DD/YYYY].
competitors:
type: array
description: List of competitors
items:
type: object
properties:
competitorId:
type: number
description: Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API].
compAccountIds:
type: array
items: {}
description: Locations Ids of competitor account [compAccountIds in Child Business of Competitor API].
topKW:
type: number
description: Count of top Keywords to be fetched.
topAd:
type: number
description: Count of top Adjectives to be fetched.
orderBy:
type: string
description: 'Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"'
sentiment:
type: number
description: -1 = negative sentiment,
example:
sourceType: review
sources:
- google
- citysearch
startDate: 11/02/2020
endDate: 01/06/2021
competitors:
- competitorId: 530846
compAccountIds:
- 162426
- 144352
- competitorId: 720708
compAccountIds:
- 165432
topKW: 25
topAd: 10
orderBy: ztoa
sentiment: -1
89Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 89
message: Rate limit exceeded
Apiary_createNewCompetitorEnterprise_Request:
type: object
properties:
businessName:
type: string
description: Location competitor name.
userEmailId:
type: string
description: Location user email.
countryCode:
type: string
description: Location country code.
phone:
type: string
description: Location phone number.
zip:
type: string
description: Zip code.
competitorId:
type: string
description: Competitor Id.
type:
type: string
description: Business type.
example:
businessName: Location_compca
userEmailId: ron@test.com
countryCode: CA
phone: 408-234-5272
zip: '95035'
competitorId: 100037693
type: Product
Apiary_getCompetitorChildBusiness_Response200:
type: array
items:
type: object
properties:
id:
type: number
description: Business ID
name:
type: string
description: Business Name
alias:
type: number
description: Business alias
address:
type: object
properties:
address1:
type: string
description: Address of the business.
address2:
type: string
description: Address of the business.
city:
type: string
description: City (Max 1000 character long).
state:
type: string
description: State (2 character state code).
countryCode:
type: string
description: Country Code (2 character country code).
zip:
type: string
description: Zip Code.
countryName:
type: string
description: Country Name (2 character country code).
description: Business address
phone:
type: string
description: Business phone.
type:
type: string
description: Type of account. e.g. Reseller (when it is a sub-reseller), Enterprise-Location (location based enterprise), Enterprise-Produ
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-competitor-api-openapi.yml