Перейти к основному содержимому

Справочник API

Этот раздел объясняет, что относится к REST-слою FastNear и как выбрать между REST-семействами до перехода к сырому JSON-RPC.

Сайдбар /api намеренно посвящён именно FastNear API, а не универсальному REST-разделу. Другие REST-семейства — Транзакции API, API переводов, NEAR Data API и KV FastData API — живут в собственных верхнеуровневых разделах.

REST-семейства с одного взгляда

СемействоНачните здесь, когда...Переключайтесь, когда...
FastNear APIнужны индексированные представления аккаунтов, токенов, NFT, стейкинга или публичных ключейтребуется каноническая семантика RPC на уровне протокола
Транзакции APIнужна история транзакций, квитанций, аккаунта или блоканужны только события переводов или точное поведение на уровне RPC
API переводоввопрос именно о движении NEAR или FT-токеноввопрос расширяется до общей истории исполнения
NEAR Data APIнужны свежие оптимистичные или финализированные чтения семейства блоковнужно точное каноническое продолжение по блоку или состоянию
KV FastData APIнужна индексированная история «ключ–значение» или последнее индексированное состояние ключанужно точное текущее состояние контракта в цепочке

Для чего нужен сам /api

Используйте раздел FastNear API, когда пользователю нужен ответ в продуктовой форме без сшивания сырых ответов узла:

  • сводки по аккаунту
  • балансы FT-токенов
  • активы NFT
  • позиции стейкинга
  • разрешение публичного ключа в аккаунт

Хорошие стартовые страницы в этом сайдбаре:

Когда не стоит стартовать с /api

Не начинайте с этого сайдбара, когда:

  • основная задача — история; используйте Транзакции API или API переводов
  • основная задача — опрос свежих блоков; используйте NEAR Data API
  • ответ должен оставаться близким к каноническим формам запроса и ответа узла; используйте Справочник RPC

Для агентов

Если вызывающая сторона — ИИ-агент и выбор всё ещё не ясен: