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 на хвилину.