Endpoint de API
Un endpoint es la URL de una función concreta de una API: un programa lo llama para obtener un tipo de datos, como los spreads Spot – Spot o las tasas de funding. La documentación lista un endpoint junto con su método HTTP: GET /arbitrage/spot-spot.
Desglose de la URL
La URL https://api.genesisarbitrage.com/v1/arbitrage/spot-spot?min_spread=0.5 en una petición 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 y versión de la API |
| Ruta | /arbitrage/spot-spot: el conjunto de datos Spot — Spot |
| Parámetro de consulta | min_spread=0.5: un spread del 0,5 % o más |
La petición devuelve oportunidades con un spread del 0,5 % o más: la moneda (coin), los exchanges de compra y de venta (exchange_buy, exchange_sell), los precios, spread_pct y los indicadores de depósito y retiro. Los demás parámetros del endpoint, coin, exchange y min_volume, están en la sección Spot — Spot.
Parámetros de ruta y de consulta
Un parámetro de ruta es parte de la propia URL; la documentación lo muestra entre llaves. En /orderbooks/coin/{coin} sustituyes {coin} por un ticker: /orderbooks/coin/BTC devuelve los libros de órdenes de BTC en todos los exchanges y mercados (Libros de órdenes de la moneda).
Los parámetros de consulta van tras el ? como pares nombre=valor separados por &. Una URL puede llevar ambos tipos: en /orderbooks/spreads/spot-futures?coin=BTC&volume=5000 el conjunto spot-futures está en la ruta, mientras que la moneda y el volumen de 5000 $ son parámetros de consulta (Δ del libro de órdenes).
Errores al llamar
| Respuesta | Causa |
|---|---|
404 not_found | No existe ese endpoint o recurso |
400 bad_request | Parámetros no válidos, detalles en message |
403 plan_restricted | El endpoint no está en tu plan |
410 gone | El endpoint está retirado, su sustituto aparece en message |
La lista completa de más de 35 endpoints está en la documentación y en la especificación legible por máquina OpenAPI.
Véase también: REST API, JSON, endpoints de arbitraje, endpoints de libros de órdenes.
Preguntas y respuestas
¿En qué se diferencia un endpoint de una API?
Una API es el conjunto completo de funciones de un servicio; un endpoint es una función con su propia URL. Genesis API tiene más de 35: arbitraje, libros de órdenes, funding, mercado, on-chain, mercados de predicción, señales de IA y búsqueda de monedas.