---
description: >-
  Welcome to the EarnBIT API Documentation! Our API provides a robust set of
  tools to help you interact with the EarnBIT Exchange. We offer both public and
  private endpoints to suit your needs.
---

# 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](exchange-api-documentation/private-endpoints-or-http/authentication-and-api-keys) (similar to [private endpoints](exchange-api-documentation/private-endpoints-or-http)) to allow you to access more data.

{% content-ref url="exchange-api-documentation/public-endpoints-or-http" %}
[public-endpoints-or-http](exchange-api-documentation/public-endpoints-or-http)
{% endcontent-ref %}

### Private endpoints

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

{% content-ref url="exchange-api-documentation/private-endpoints-or-http" %}
[private-endpoints-or-http](exchange-api-documentation/private-endpoints-or-http)
{% endcontent-ref %}

## WEBSOKET API

### Basic structure

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

{% content-ref url="exchange-api-documentation/basic-structure-or-websoket" %}
[basic-structure-or-websoket](exchange-api-documentation/basic-structure-or-websoket)
{% 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="exchange-api-documentation/public-methods-or-websoket" %}
[public-methods-or-websoket](exchange-api-documentation/public-methods-or-websoket)
{% 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](exchange-api-documentation/private-methods-or-websoket/authorization) to use these methods.

{% content-ref url="exchange-api-documentation/private-methods-or-websoket" %}
[private-methods-or-websoket](exchange-api-documentation/private-methods-or-websoket)
{% endcontent-ref %}
