> For the complete documentation index, see [llms.txt](https://pointpay.gitbook.io/base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pointpay.gitbook.io/base/documentation/developers/exchange-api-documentation.md).

# Exchange API Documentation

## HTTP API

### Public endpoints

Public endpoints are ideal for retrieving general data and are accessible without the need for an API key. These endpoints use the `GET` method for requests. Each public endpoint can also be used as a `POST` request with [authentication](/base/documentation/developers/exchange-api-documentation/authentication-and-api-keys.md) (similar to [private endpoints](/base/documentation/developers/exchange-api-documentation/spot-private-endpoints-or-http.md)) to allow you to access more data.

{% content-ref url="/pages/sYbe5XonYezaLdwH7WHY" %}
[Spot public endpoints | HTTP](/base/documentation/developers/exchange-api-documentation/spot-public-endpoints-or-http.md)
{% endcontent-ref %}

### Private endpoints

Private endpoints offer full access to data and features. To use these endpoints, an[ API key](/base/documentation/developers/exchange-api-documentation/authentication-and-api-keys.md) is required, which you can generate directly from your PointPay Exchange profile.

{% content-ref url="/pages/0ZvFoPS8qDPFyQHIIPtt" %}
[Spot private endpoints | HTTP](/base/documentation/developers/exchange-api-documentation/spot-private-endpoints-or-http.md)
{% endcontent-ref %}

## Futures endpoints

### Futures public endpoints

Methods for retrieving general data and do not require authentication.

{% content-ref url="/pages/67d0e49b2eb09137182f2696b29f17c567dc116d" %}
[Futures public endpoints](/base/documentation/developers/exchange-api-documentation/futures-public-endpoints.md)
{% endcontent-ref %}

### Futures private endpoints

Methods that offer full access to data and features. To use these endpoints, an API key is required, which you can generate directly from your PointPay Exchange profile.

{% content-ref url="/pages/684ca4ae52d1c88faf8e786c59eccb690c301890" %}
[Futures private endpoints](/base/documentation/developers/exchange-api-documentation/futures-private-endpoints.md)
{% endcontent-ref %}

## WEBSOKET API

### Basic structure

This section describes the basic structure of WS requests and responses.

{% content-ref url="/pages/iyWTXKP8B5TiskeJ10x9" %}
[Basic structure | WEBSOKET](/base/documentation/developers/exchange-api-documentation/basic-structure-or-websoket.md)
{% endcontent-ref %}

### Public methods

Methods to access public data like market history, order book, etc. After establishing the WebSocket connection, the user does not need to be authorized to use these methods.

{% content-ref url="/pages/IRKqu94NGix4A2A9nVUA" %}
[Public methods | WEBSOKET](/base/documentation/developers/exchange-api-documentation/public-methods-or-websoket.md)
{% endcontent-ref %}

### Private methods

Methods to access private data related to balances, orders, etc. After establishing the WebSocket connection, the user has to be [authorized](/base/documentation/developers/exchange-api-documentation/private-methods-or-websoket/authorization.md) to use these methods.

{% content-ref url="/pages/S9XMwKHKlYGAYpE69M4o" %}
[Private methods | WEBSOKET](/base/documentation/developers/exchange-api-documentation/private-methods-or-websoket.md)
{% endcontent-ref %}
