Introduction

The Bitfinex API’s are designed to allow access to all of the features of the Bitfinex platform. The end goal is to allow people to potentially recreate the entire platform on their own.

If you would like to suggest changes to the documentation, please see the github at https://github.com/bitfinexcom/api_docs

Open Source Libraries

The following open source projects are works in progress. We will be continually improving them, but we want to release them early so that the community can take a look, make use of them, and offer pull requests. Nothing in the Bitcoin world exists in isolation.

Get Started    

URL

Endpoints that require authentication should use the domain:
https://api.bitfinex.com/

Public endpoints should use the domain:
https://api-pub.bitfinex.com/

// Public endpoint
https://api-pub.bitfinex.com/v2/<endpoint>/?parameter=value...

// Authenticated endpoint
https://api.bitfinex.com/v2/<endpoint>/?parameter=value...

Where <endpoint> is one of the public / authenticated endpoints.

Parameters

Requests parameters for GET requests are appended to the URL being called as follows:

NOTE

In order to offer the best service possible we have added a rate limit to the number of REST requests.
Our rate limit policy can vary in a range of 10 to 90 requests per minute depending on some factors (e.g. servers load, endpoint, etc.).

Maintenance

Maintenance error

When in maintenance few API endpoints (eg. books, ...) will return a maintenance error to prevent you to use potentially inconsistent data.
["error", 20060, "maintenance"]

General


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.