GET /apiv2/screening/price
Стоимость одной проверки от одного провайдера, а также информация о том, покрывает ли её ваш баланс.
Это контракт версии 2. Он заменяет GET /apiv2/aml/price, который продолжает работать.
URL эндпоинта
GET https://netts.io/apiv2/screening/price?provider=ellipticЗаголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
| X-API-KEY | Да | Ваш API-ключ из панели управления Netts |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| provider | string | Да | elliptic или bitok. Значение по умолчанию отсутствует |
В версии 1 этот параметр по умолчанию принимает значение elliptic, поэтому вызывающей стороне, опустившей его, возвращалась цена для провайдера, которого она не указывала. В теле проверки действует то же правило.
Пример запроса
curl "https://netts.io/apiv2/screening/price?provider=elliptic" \
-H "X-API-KEY: your_api_key"Ответ
{
"schema_version": 2,
"provider": "elliptic",
"price_usdt": "0.98",
"price_trx": "2.884881",
"available": true,
"networks": ["trx", "eth", "btc", "..."],
"score_scale": { "min": 0, "max": 10 },
"trx_rate_usd": "0.339702",
"balance_trx": "113.910000",
"can_afford": true
}| Поле | Тип | Описание |
|---|---|---|
| provider | string | Запрашиваемый провайдер |
| price_usdt | string | Базовая стоимость одной проверки в USDT |
| price_trx | string | null | Та же стоимость, пересчитанная по текущему курсу |
| available | boolean | Можно ли заказать проверки прямо сейчас |
| reason | string | Присутствует только тогда, когда available имеет значение false. В настоящее время quota_exhausted |
| networks | array | Тикеры сетей, поддерживаемых данным провайдером |
| score_scale | object | min и max собственной шкалы оценки провайдера |
| trx_rate_usd | string | null | Курс, использованный для конвертации |
| balance_trx | string | Ваш баланс TRX |
| can_afford | boolean | balance_trx не меньше price_trx |
Поле can_afford предназначено для удобства и не является резервированием средств. Курс может измениться, а баланс может быть потрачен на другие операции между этим вызовом и самой проверкой. Окончательный ответ даёт сама проверка, которая отклоняется с кодом 1004 и указанием сумм.
Суммы указываются с точностью до шести знаков после запятой — именно с такой точностью TRX фактически списываются с баланса, это не просто формат отображения. Они представлены в виде строк с десятичными числами по причине, описанной в разделе Числа являются строками.
Наценка субпользователя включена в price_trx точно так же, как она включается в списываемую сумму.
Ошибки
RFC 9457, application/problem+json.
| Код | HTTP | Условие |
|---|---|---|
4001 | 400 | provider отсутствует или не является известным провайдером |
4002 | 403 | Провайдер существует, но недоступен для вашего аккаунта |
4010 / 4011 | 401 | API-ключ отсутствует, либо передан неприемлемый ключ или IP |
5030 | 503 | Провайдер временно недоступен |
{
"type": "https://doc.netts.io/api/v2/errors/provider-unavailable-for-account",
"title": "Provider is not available for your account",
"status": 403,
"detail": "BitOK is not available for your account. Please use Elliptic.",
"instance": "/apiv2/screening/price",
"code": 4002
}Ограничения частоты запросов
Общие со всеми остальными путями AML: 5 запросов в секунду, 150 в минуту.