Exchange API Documentation

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

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 (similar to private endpoints) to allow you to access more data.

Public endpoints | HTTP

Private endpoints

Private endpoints 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.

Private endpoints | HTTP

WEBSOKET API

Basic structure

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

Basic structure | WEBSOKET

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.

Public methods | WEBSOKET

Private methods

Methods to access private data related to balances, orders, etc. After establishing the WebSocket connection, the user has to be authorized to use these methods.

Private methods | WEBSOKET