API endpoint
An endpoint is the URL of one specific API function: a program calls it to get one kind of data, such as Spot – Spot spreads or funding rates. Documentation lists an endpoint together with its HTTP method: GET /arbitrage/spot-spot.
URL breakdown
The URL https://api.genesisarbitrage.com/v1/arbitrage/spot-spot?min_spread=0.5 in a curl request:
BASE="https://api.genesisarbitrage.com/v1"
curl "$BASE/arbitrage/spot-spot?min_spread=0.5" \
-H "X-API-Key: $GENESIS_API_KEY"
| Part | Value |
|---|---|
| Base URL | https://api.genesisarbitrage.com/v1: server and API version |
| Path | /arbitrage/spot-spot: the Spot — Spot dataset |
| Query parameter | min_spread=0.5: a spread of 0.5% or more |
The request returns setups with a spread of 0.5% or more: the coin (coin), the buy and sell exchanges (exchange_buy, exchange_sell), prices, spread_pct and deposit and withdrawal flags. The endpoint's other parameters, coin, exchange and min_volume, are listed in the Spot — Spot section.
Path parameters and query parameters
A path parameter is part of the URL itself; documentation shows it in curly braces. In /orderbooks/coin/{coin} you replace {coin} with a ticker: /orderbooks/coin/BTC returns BTC order books on every exchange and market (Coin order books).
Query parameters follow the ? as name=value pairs separated by &. One URL can carry both kinds: in /orderbooks/spreads/spot-futures?coin=BTC&volume=5000 the spot-futures dataset sits in the path, while the coin and the $5,000 volume are query parameters (Order-book Δ).
Errors when calling
| Response | Cause |
|---|---|
404 not_found | No such endpoint or resource |
400 bad_request | Invalid parameters, details in message |
403 plan_restricted | The endpoint is not in your plan |
410 gone | The endpoint is retired, its replacement is in message |
The full list of 35+ endpoints is in the documentation and in the machine-readable OpenAPI specification.
See also: REST API, JSON, arbitrage endpoints, order book endpoints.
Questions and answers
How is an endpoint different from an API?
An API is the whole set of a service's functions; an endpoint is one function with its own URL. Genesis API has more than 35 of them: arbitrage, order books, funding, market, on-chain, prediction markets, AI signals and coin search.