Endpoint de API
Um endpoint é a URL de uma função específica de uma API: um programa o chama para obter um tipo de dado, como os spreads Spot – Spot ou as taxas de funding. A documentação lista um endpoint junto com seu método HTTP: GET /arbitrage/spot-spot.
Anatomia da URL
A URL https://api.genesisarbitrage.com/v1/arbitrage/spot-spot?min_spread=0.5 em uma requisição curl:
BASE="https://api.genesisarbitrage.com/v1"
curl "$BASE/arbitrage/spot-spot?min_spread=0.5" \
-H "X-API-Key: $GENESIS_API_KEY"
| Parte | Valor |
|---|---|
| URL base | https://api.genesisarbitrage.com/v1: servidor e versão da API |
| Caminho | /arbitrage/spot-spot: o conjunto de dados Spot — Spot |
| Parâmetro de consulta | min_spread=0.5: spread de 0,5% ou mais |
A requisição devolve oportunidades com spread de 0,5% ou mais: a moeda (coin), as exchanges de compra e de venda (exchange_buy, exchange_sell), os preços, spread_pct e os flags de depósito e saque. Os demais parâmetros do endpoint, coin, exchange e min_volume, estão listados na seção Spot — Spot.
Parâmetros de caminho e de consulta
Um parâmetro de caminho faz parte da própria URL; a documentação o mostra entre chaves. Em /orderbooks/coin/{coin} você troca {coin} por um ticker: /orderbooks/coin/BTC devolve os order books do BTC em todas as exchanges e mercados (Order books da moeda).
Os parâmetros de consulta vêm depois do ? como pares nome=valor separados por &. Uma mesma URL pode ter os dois tipos: em /orderbooks/spreads/spot-futures?coin=BTC&volume=5000, o conjunto spot-futures está no caminho, enquanto a moeda e o volume de US$ 5.000 são parâmetros de consulta (Δ do order book).
Erros ao chamar
| Resposta | Causa |
|---|---|
404 not_found | Esse endpoint ou recurso não existe |
400 bad_request | Parâmetros inválidos, detalhes em message |
403 plan_restricted | O endpoint não está no seu plano |
410 gone | O endpoint foi aposentado, o substituto está em message |
A lista completa de mais de 35 endpoints está na documentação e na especificação legível por máquina OpenAPI.
Veja também: REST API, JSON, endpoints de arbitragem, endpoints de order book.
Perguntas e respostas
Qual a diferença entre um endpoint e uma API?
A API é o conjunto completo das funções de um serviço; o endpoint é uma função com sua própria URL. A Genesis API tem mais de 35: arbitragem, order books, funding, mercado, on-chain, mercados de previsão, sinais de IA e busca de moedas.