---
title: Competitors API
description: In this documentation, you can find descriptions of the BrandWizard API methods for the Competitors section.
---

[Skip to content](https://help.brandwizard.io/knowledge/competitors-api#main-content)

English

Show submenu for translations

![logo2.png\]](https://help.brandwizard.io/hs-fs/hubfs/logo2.png?height=40&name=logo2.png)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations
- [Go to brandwizard.io](https://brandwizard.io/)

[Go to brandwizard.io](https://brandwizard.io/)

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [Help Center](https://help.brandwizard.io/knowledge?hsLang=en)
2. [General questions about the service](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en)
3. [API](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#api)

# Competitors API

In this documentation, you can find descriptions of the [BrandWizard API](https://api.brandwizard.io/public/swagger-ui/#/Competitors) methods for the **Competitors** section.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/8ce46b458a681bc3d2d06275eb28b68e0791bd74)

 

**Method GET**[**/public/competitors/**](https://api.brandwizard.io/public/swagger-ui/#/Competitors/competitors_list)

- **Description:** List of your competitors with their source networks, locations, and status.
- **Request parameters:**
  
  | Parameter | Type | Required? | Description |
  | --- | --- | --- | --- |
  | **count** | integer | No | Number of results for paginated return |
  | **page** | integer | No | Page number within the paginated result set |
- **Response fields:**
  
   
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | **count** | integer | Number of records |  |
  | **next** | string | Link to the next page |  |
  | **previous** | string | Link to the previous page |  |
  | **results** | **id** | integer | Competitor ID |
  | **name** | string | Competitor name |  |
  | **networks** | **website** | string | Catalog website, e.g. google\_maps, 2gis.ru, yandex\_maps |
  | **type** | string | Source type: network or organization |  |
  | **external\_id** | string | Network ID in the catalog |  |
  | **status** | string | Source processing status |  |
  | **locations** | **company\_id** | integer | Company ID |
  | **name** | string | Location name |  |
  | **city** | string | City |  |
  | **address** | string | Address |  |
  | **is\_closed** | boolean | true if the competitor location is closed |  |
  | **catalogs** | **website** | string | Catalog website |
  | **origin\_id** | string | Location ID in the catalog |  |
  | **origin\_url** | string | Location URL in the catalog |  |
  | **catalog\_status** | string | Location status in the catalog |  |

**Method GET**[**/public/competitors/metrics/**](https://api.brandwizard.io/public/swagger-ui/#/Competitors/competitors_metrics_list)

- **Description:** Metrics by catalog for your competitors' locations, with optional rating history.
- **Request parameters:**
  
  | Parameter | Type | Required? | Description |
  | --- | --- | --- | --- |
  | **catalog** | string | No | Catalog, available options: 2gis.ru, google, yandex. Must select one. |
  | **city\_ids** | array\[integer\] | No | City IDs where competitor locations are located (pass an array of city IDs) |
  | **code** | string | No | Competitor branch code |
  | **competitor\_id** | integer | No | Competitor ID |
  | **count** | integer | No | Number of results for paginated return |
  | **end\_date** | string | No | End of the rating history period (together with start\_date). Date format |
  | **page** | integer | No | Page number within the paginated result set |
  | **start\_date** | string | No | Start of the rating history period (together with end\_date). Date format |
- **Response fields:**
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | **count** | integer | Number of records (e.g., 123) |  |
  | **next** | string | Link to the next page |  |
  | **previous** | string | Link to the previous page |  |
  | **results** | **competitor\_id** | integer | Competitor ID |
  | **competitor\_name** | string | Competitor name |  |
  | **company\_id** | integer | Company ID |  |
  | **name** | string | Location name |  |
  | **city** | string | City |  |
  | **address** | string | Address |  |
  | **metrics** | **website** | string | Catalog website |
  | **reviews\_count** | integer | Number of reviews |  |
  | **ratings\_count** | integer | Number of ratings (not provided by Google) |  |
  | **rating** | number | Average rating |  |
  | **is\_verified** | boolean | Blue checkmark / verified owner (for Yandex catalog) |  |
  | **has\_priority\_placement** | boolean | Paid placement |  |
  | **is\_closed** | boolean | Location closure status |  |
  | **rating\_history** | **date** | string | Date (day) |
  | **rating** | number | Rating for that day |  |

- [General questions about the service](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#main-content)

    - [FAQ](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#faq)
    - [Creating and editing a company](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#creating-and-editing-a-company)
    - [Working with sources](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#working-with-sources)
    - [Work with reviews](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#work-with-reviews)
    - [Working with a Photo tool](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#working-with-a-photo-tool)
    - [Google](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#google)
    - [2GIS (URBI)](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#2gis-urbi)
    - [Facebook](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#facebook)
    - [Yandex](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#yandex)
    - [API](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#api)
- [Where to start?](https://help.brandwizard.io/knowledge/where-to-start?hsLang=en)
- [Dashboard](https://help.brandwizard.io/knowledge/dashboard?hsLang=en)
- [My companies](https://help.brandwizard.io/knowledge/my-companies?hsLang=en)
- [Create/Edit company in Personal account](https://help.brandwizard.io/knowledge/create-edit-company-in-personal-account?hsLang=en)
- [Sources](https://help.brandwizard.io/knowledge/sources?hsLang=en)
- [Review Center](https://help.brandwizard.io/knowledge/review-center?hsLang=en)
- [Tags](https://help.brandwizard.io/knowledge/tags?hsLang=en)
- [Auto-replies](https://help.brandwizard.io/knowledge/auto-replies?hsLang=en)
- [Statistics](https://help.brandwizard.io/knowledge/statistics?hsLang=en)
- [Reputation Analytics](https://help.brandwizard.io/knowledge/reputation-analytics?hsLang=en)
- [Competitors](https://help.brandwizard.io/knowledge/competitors?hsLang=en)
- [Reviews generator](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#main-content)

    - [QR Codes](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#qr-codes)
    - [Analytics](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#analytics)
    - [Promo codes](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#promo-codes)
    - [Questionnaires](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#questionnaires)
- [Questions & Answers](https://help.brandwizard.io/knowledge/questions-answers?hsLang=en)
- [Photo & Video](https://help.brandwizard.io/knowledge/photo-video?hsLang=en)
- [Presence analytics](https://help.brandwizard.io/knowledge/presence-analytics?hsLang=en)
- [Reviews widget](https://help.brandwizard.io/knowledge/reviews-widget?hsLang=en)
- [Store locator](https://help.brandwizard.io/knowledge/store-locator?hsLang=en)
- [Multichat](https://help.brandwizard.io/knowledge/multichat?hsLang=en#main-content)

    - [Where to start?](https://help.brandwizard.io/knowledge/multichat?hsLang=en#where-to-start)
    - [Adding inboxes](https://help.brandwizard.io/knowledge/multichat?hsLang=en#adding-inboxes)
    - [Conversations](https://help.brandwizard.io/knowledge/multichat?hsLang=en#conversations)
    - [Contacts](https://help.brandwizard.io/knowledge/multichat?hsLang=en#contacts)
    - [Settings](https://help.brandwizard.io/knowledge/multichat?hsLang=en#settings)
    - [Reports](https://help.brandwizard.io/knowledge/multichat?hsLang=en#reports)
    - [Additional features](https://help.brandwizard.io/knowledge/multichat?hsLang=en#additional-features)
- [Posts](https://help.brandwizard.io/knowledge/posts?hsLang=en)
- [Duplicates & Fakes](https://help.brandwizard.io/knowledge/duplicates-fakes?hsLang=en)
- [Products & Prices](https://help.brandwizard.io/knowledge/products-prices?hsLang=en)
- [Plans & Limits](https://help.brandwizard.io/knowledge/plans-limits?hsLang=en)
- [Profile](https://help.brandwizard.io/knowledge/profile?hsLang=en)
- [Users](https://help.brandwizard.io/knowledge/users?hsLang=en)
- [Account settings](https://help.brandwizard.io/knowledge/account-settings?hsLang=en)
- [Groups of companies section](https://help.brandwizard.io/knowledge/groups-of-companies-section?hsLang=en)
- [Notifications settings](https://help.brandwizard.io/knowledge/notifications-settings?hsLang=en)

# BrandWizard

brandwizard.io Help Center

Copyright © 2026, BrandWizard