Our API allows you to automate your trading experience and manage your trade, offer, and wallet actions effortlessly.
Latest version of API docs can be found here - Paxful API (OpenAPI) doc.
Readthedocs.io version of API docs is still available, but it is no longer maintained and will be decommissioned in the nearest future.
When setting up your API, you have two options for the type of authentication you can use, which is either a signature-based authentication (also known as apiseal) or an OAuth 2.0 protocol-based authentication.
Below you can find a more detailed description of both authentication methods and how to set them up.
The advantage of this authentication is that if you haven’t used OAuth 2.0 integration libraries before in your projects, then creating a signature and sending a request is something you can do without adding additional libraries. On the flip side, you must be an owner of the account that you will be automating, while with OAuth 2.0, you may request access permissions and start performing actions on a user’s behalf (with the help of our Sign in with Paxful product).
You can also follow this guide to see examples of code on how to do that.
You will need to use this approach to integrate with our Paxful Pay and Kiosk features.
If you are developing an application that is not using Paxful Pay or Kiosk, we recommend using the OAuth 2.0 authentication.
One of the benefits of this authentication method is that besides working with your own account, you can request the user’s permission to access their account using the Sign in with Paxful product.
If you are creating a new product, we recommend considering using OAuth 2.0. We will be building additional tools such as telemetry, errors reporting, webhooks API, and a more flexible rate limiting.
For information as to how to authenticate using OAuth 2.0, please refer to Authentication section in Application Development guide.