Skip to main content
Technical

Endpoint

An endpoint is a specific URL where an API can be accessed. Each endpoint typically handles a specific type of request or returns a specific type of data.

Understanding the Concept

Think of endpoints as doors into an API. Each door leads somewhere different. /ticker gives you prices. /ohlcv gives you candles. /orderbook gives you depth. You knock on the right door for what you need.

Well-designed endpoints follow REST conventions: nouns for resources (/assets, /exchanges), HTTP verbs for actions (GET to read, POST to create). The URL structure should be predictable—once you know the pattern, you can guess endpoints you haven't seen.

Endpoints have parameters too. Path parameters identify resources (/ticker/bitcoin). Query parameters filter or modify results (?interval=1h&limit=100).

Real-World Example

PRISM API endpoints: GET /v1/assets (list all assets), GET /v1/ticker/{symbol} (get price), GET /v1/ohlcv/{symbol} (get candles), GET /v1/exchanges (list exchanges). Clear, predictable, RESTful.

How PRISM Handles This

PRISM organizes endpoints logically: /assets for reference data, /ticker for prices, /ohlcv for historical candles, /orderbook for depth. Full documentation with examples for every endpoint. Interactive API explorer to test requests.

View API Docs