Competitors

Ready-to-use workflows

01

Start using Competitors

Use a dedicated API token and validate read operations with test data first.

Keep the token server-side and send it in the Authorization header.
Check required parameters and expand the request or response schema.
Handle the HTTP status and the stable error field in application errors.

PUTUpdate DELETEDelete GETGet All

Data model

Data structures

Models are listed once here and can also be expanded directly from the endpoints that use them.

Competitor6 fields

idinteger · int64

Id.

read-only

modelIdinteger · int64

Model Id.

servicestring

Service.

Required

urlstring

Url.

Required

serviceIdstring

Service Id.

clientIdinteger · int64

Client Id.

read-only

Error contract

How application errors are returned

The error code is identical in every locale, while the user-facing message is translated by the server. Build application logic around error and use localMessage for display only.

error

Stable machine-readable code for integration logic.

localMessage

Display-ready message in the API token user's language.

params

Values interpolated by the server into the localized message template.

文

localMessage uses the lang field of the user who owns the API token. The documentation language and Accept-Language header do not change it; Russian is used when the user has no language configured.

RUUser locale is ru

{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}

ENUser locale is en

{
  "error": "error_brand_already_exists",
  "localMessage": "Brand Base already exists",
  "params": {
    "name": "Base"
  }
}

Endpoints

PUT

Update

/api/competitor/{competitorId}

Token with write access

Update using PUT /api/competitor/{competitorId}.

Path parameters

Field	Type	Required	Description
`competitorId`	integer · int64	Yes	Competitor Id.

Request body

application/json

Object fieldsCompetitor

Field	Type	Required	Description
`id`	integer · int64	No	Id.
`modelId`	integer · int64	No	Model Id.
`service`	stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC	Yes	Service.
`url`	string	Yes	Url.
`serviceId`	string	No	Service Id.
`clientId`	integer · int64	No	Client Id.

curl --request PUT 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

const response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'PUT',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "service": "NONE",
    "url": "https://example.com",
    "id": 1001,
    "modelId": 1001,
    "serviceId": "string",
    "clientId": 1001
  }),
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const response: Response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'PUT',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "service": "NONE",
    "url": "https://example.com",
    "id": 1001,
    "modelId": 1001,
    "serviceId": "string",
    "clientId": 1001
  }),
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

import os
import requests

response = requests.put(
    'https://api.selsup.ru/api/competitor/1001',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
    json={
        'service': 'NONE',
        'url': 'https://example.com',
        'id': 1001,
        'modelId': 1001,
        'serviceId': 'string',
        'clientId': 1001
    },
)
response.raise_for_status()

<?php

$payload = <<<'JSON'
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
JSON;

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/competitor/1001',
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN'), 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
    "strings"
)

func main() {
    req, err := http.NewRequest("PUT", "https://api.selsup.ru/api/competitor/1001", strings.NewReader(`{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}`))
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))
    req.Header.Set("Content-Type", "application/json")

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/competitor/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("""
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
"""))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Success response

200

The response has no body.

Errors8

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required

Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied

Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown

Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_competitor_id_required

Competitor id is required

Endpoint-specific error. Use the stable error_competitor_id_required code in application logic; localMessage contains the translation shown above.

400error_competitor_required

Competitor is required

Endpoint-specific error. Use the stable error_competitor_required code in application logic; localMessage contains the translation shown above.

400error_competitor_service_required

Competitor service is required

Endpoint-specific error. Use the stable error_competitor_service_required code in application logic; localMessage contains the translation shown above.

400error_competitor_url_required

Competitor URL is required

Endpoint-specific error. Use the stable error_competitor_url_required code in application logic; localMessage contains the translation shown above.

400error_no_client

The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

DELETE

Delete

/api/competitor/{competitorId}

Token with write access

Delete using DELETE /api/competitor/{competitorId}.

Path parameters

Field	Type	Required	Description
`competitorId`	integer · int64	Yes	Competitor Id.

curl --request DELETE 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'DELETE',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const response: Response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'DELETE',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

import os
import requests

response = requests.delete(
    'https://api.selsup.ru/api/competitor/1001',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/competitor/1001',
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("DELETE", "https://api.selsup.ru/api/competitor/1001", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/competitor/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("DELETE", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Success response

200

The response has no body.

Errors5

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required

Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied

Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown

Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_competitor_id_required

Competitor id is required

Endpoint-specific error. Use the stable error_competitor_id_required code in application logic; localMessage contains the translation shown above.

400error_no_client

The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

GET

Get All

/api/competitor/{modelId}

Token with read access

Get All using GET /api/competitor/{modelId}.

Path parameters

Field	Type	Required	Description
`modelId`	integer · int64	Yes	Model Id.

curl --request GET 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/competitor/1001',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/competitor/1001',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/competitor/1001", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/competitor/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Success response

200

Array item structure Competitor[]

Field	Type	Required	Description
`id`	integer · int64	No	Id.
`modelId`	integer · int64	No	Model Id.
`service`	stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC	Yes	Service.
`url`	string	Yes	Url.
`serviceId`	string	No	Service Id.
`clientId`	integer · int64	No	Client Id.

[
  "string"
]

Errors5

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required

Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied

Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown

Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_model_id_required

Model id is required

Endpoint-specific error. Use the stable error_model_id_required code in application logic; localMessage contains the translation shown above.

400error_no_client

The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

POST

Create

/api/competitor/{modelId}

Token with write access

Create using POST /api/competitor/{modelId}.

Path parameters

Field	Type	Required	Description
`modelId`	integer · int64	Yes	Model Id.

Request body

application/json

Object fieldsCompetitor

Field	Type	Required	Description
`id`	integer · int64	No	Id.
`modelId`	integer · int64	No	Model Id.
`service`	stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC	Yes	Service.
`url`	string	Yes	Url.
`serviceId`	string	No	Service Id.
`clientId`	integer · int64	No	Client Id.

curl --request POST 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

const response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'POST',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "service": "NONE",
    "url": "https://example.com",
    "id": 1001,
    "modelId": 1001,
    "serviceId": "string",
    "clientId": 1001
  }),
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/competitor/1001', {
  method: 'POST',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "service": "NONE",
    "url": "https://example.com",
    "id": 1001,
    "modelId": 1001,
    "serviceId": "string",
    "clientId": 1001
  }),
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.post(
    'https://api.selsup.ru/api/competitor/1001',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
    json={
        'service': 'NONE',
        'url': 'https://example.com',
        'id': 1001,
        'modelId': 1001,
        'serviceId': 'string',
        'clientId': 1001
    },
)
response.raise_for_status()
result = response.json()

<?php

$payload = <<<'JSON'
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
JSON;

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/competitor/1001',
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN'), 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
    "strings"
)

func main() {
    req, err := http.NewRequest("POST", "https://api.selsup.ru/api/competitor/1001", strings.NewReader(`{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}`))
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))
    req.Header.Set("Content-Type", "application/json")

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/competitor/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
"""))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Success response

200

Object fields Competitor

Field	Type	Required	Description
`id`	integer · int64	No	Id.
`modelId`	integer · int64	No	Model Id.
`service`	stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC	Yes	Service.
`url`	string	Yes	Url.
`serviceId`	string	No	Service Id.
`clientId`	integer · int64	No	Client Id.

{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}

Errors7

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required

Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied

Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown

Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_competitor_required

Competitor is required

Endpoint-specific error. Use the stable error_competitor_required code in application logic; localMessage contains the translation shown above.

400error_competitor_service_required

Competitor service is required

Endpoint-specific error. Use the stable error_competitor_service_required code in application logic; localMessage contains the translation shown above.

400error_competitor_url_required

Competitor URL is required

Endpoint-specific error. Use the stable error_competitor_url_required code in application logic; localMessage contains the translation shown above.

400error_no_client

The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

Ready-to-use workflows

Start using Competitors

Data structures

How application errors are returned

Endpoints

Update

Path parameters

Request body

Success response

Delete

Path parameters

Success response

Get All

Path parameters

Success response

Create

Path parameters

Request body

Success response

Token for test requests

Real request parameters

Live API response