Introduction

The PeerIndex API is RESTful. The user uses standard HTTP calls (GET) to URLs and the server returns the data in a machine-readable format.

All of the calls use the base URL of:

http://api.peerindex.net/

All of the calls require an API key. Get an API key.

Rate Limiting

To ensure that all developers have access to the PeerIndex API we rate limit the number of calls to 10,000 a day. Should you exceed that limit any further calls will return a rate limit exceeded error. The calls are counted on a date basis from 00:00:00 to 23:59:59 UTC. So if you use up all the calls in 1 hour you will need to wait until 00:00:00 the following day in order to make any further calls.

You can monitor your rate limit consumption using the headers

• X-RateLimit-Limit

  The number of calls per day for the key.

  X-RateLimit-Limit: 10000
• X-RateLimit-Remaining

  The number of calls remaining for the 24 hour period.

  X-RateLimit-Remaining: 492
• X-RateLimit-Reset

  The reset time for the rate limits (midnight, UTC).

  X-RateLimit-Reset: 1306969200

Applications that continue to make excessive calls to the API after the rate limit is passed will be blocked.

Standard Errors

• Rate limit exceeded

  If you exceed the call limit per day, PeerIndex will return the following error

  { "error": "Rate limit exceeded" }
• Missing parameter

  If you have not included a required parameter, PeerIndex will return the following error

  { "error": "Missing parameter: api_key" }
• Invalid API key

  If the API key used is invalid, PeerIndex will return the following error

  { "error": "Invalid API key" }