API Documentation

There are multiple public endpoints that return JSON data from this site. In general the data is updated every 15 minutes. Caching rules are set to store responses up to 15 minutes.

Versions

The current version must be prepended to all API requests. A request /spot should be made as /v1.1/spot.

Additional features will be added to the current version. But breaking features or bugfixes will increment the version. This ensures (for a certain grace period) that older clients can continue to work with the API as expected.

/v1.1 Current release.
/v1.0 The initial release. no longer accessible

JSON

The API defaults to JSON responses.

CSV

All endpoints allow for csv responses. A csv response can be initiated by appending .csv to the request path. The csv is utf-8 encoded and has a , comma as field separator. Each line is separated with a unix newline character \n.

Example:

curl http://bitcoinppi.com/v1.1/spot.csv

curl http://bitcoinppi.com/v1.1/countries/DE.csv?from=2015-01-01&to=2015-11-14

GET parameters

All endpoints except for /spot accept these optional parameters that let you define the timeframe and resolution.

All times are expected in UTC, and to is expected to be later than from. For calculting the resolution, the given times will be truncated to their unit of resolution (e.g. '2015-10-14 12:47' will become '2015-10-14 12:00' when using '1 hour'). The param tick must not be given, and by default the lowest resolution available will be chosen.

from: default: 1 year ago
format: YYYY-mm-dd or YYYY-mm-dd HH:00
to: default: now
format: YYYY-mm-dd or YYYY-mm-dd HH:00
tick: default: lowest available for given timeframe
allowed: 7 days, 1 day, 12 hours, 1 hour, 15 minutes

GET /spot

This endpoint returns data within the last 24 hours. GET parameters are ignored. Note the JSON response returns both countries and spot data for convenience. If you request /v1.1/spot.csv for retrieving CSV data, the response will be limited to spot data. See /spot_countries for countries spot data.

JSON Example:

curl http://bitcoinppi.com/v1.1/spot

Response:

{
  "spot": {
    "tick": "2015-10-15T10:30:00.000+02:00",
    "global_ppi": "51.110243502525189243",
    "avg_24h_global_ppi": "50.9007122538474498736044"
  },
  "countries": {
    "CN": {
      "time": "2015-10-15T10:44:12.000+02:00",
      "tick": "2015-10-15T10:30:00.000+02:00",
      "country": "CN",
      "currency": "CNY",
      "bitcoin_price": "1652.15",
      "bigmac_price": "17.0",
      "weight": "0.1",
      "local_ppi": "97.1852941176470588",
      "avg_24h_local_ppi": "96.2611118293471235"
    },
    ...
    "US": {
      "time": "2015-10-15T10:44:12.000+02:00",
      "tick": "2015-10-15T10:30:00.000+02:00",
      "country": "US",
      "currency": "USD",
      "bitcoin_price": "255.06",
      "bigmac_price": "4.79",
      "weight": "0.05",
      "local_ppi": "53.2484342379958246",
      "avg_24h_local_ppi": "53.2046387850145679"
    }
  }   
}

CSV Example:

curl http://bitcoinppi.com/v1.1/spot.csv

Response:

tick,global_ppi,avg_24h_global_ppi,global_ppi_24h_ago
2015-11-14 11:45:00,99.606549,99.2257244270833333,99.03269

GET /spot_countries

This endpoint only returns countries spot data.

JSON Example:

curl http://bitcoinppi.com/v1.1/spot_countries

Response:

{
  "countries": {
    "CN": {
      "time": "2015-10-15T10:44:12.000+02:00",
      "tick": "2015-10-15T10:30:00.000+02:00",
      "country": "CN",
      "currency": "CNY",
      "bitcoin_price": "1652.15",
      "bigmac_price": "17.0",
      "weight": "0.1",
      "local_ppi": "97.1852941176470588",
      "avg_24h_local_ppi": "96.2611118293471235"
    },
    ...
    "US": {
      "time": "2015-10-15T10:44:12.000+02:00",
      "tick": "2015-10-15T10:30:00.000+02:00",
      "country": "US",
      "currency": "USD",
      "bitcoin_price": "255.06",
      "bigmac_price": "4.79",
      "weight": "0.05",
      "local_ppi": "53.2484342379958246",
      "avg_24h_local_ppi": "53.2046387850145679"
    }
  }   
}

CSV Example:

curl http://bitcoinppi.com/v1.1/spot_countries.csv

Response:

time,tick,country,currency,bitcoin_price,bigmac_price,weight,local_ppi,avg_24h_local_ppi
2015-11-14 11:57:04,2015-11-14 11:45:00,IN,INR,19938.46,116.25,0.086645,171.513634,171.9353557173913043
...

GET /global_ppi

This endpoint returns all global_ppi values over a defined time series. The timeframe can be adjusted using the GET parameters declared above. By default it returns data from the last year at a resolution of 1 day.

The default response type is JSON. To receive a CSV response, append .csv to the request path.

JSON Examples:

curl http://bitcoinppi.com/v1.1/global_ppi

curl 'http://bitcoinppi.com/v1.1/global_ppi?from=2011-07-01&to=2013-04-30'

curl 'http://bitcoinppi.com/v1.1/global_ppi?from=2011-07-01&to=2013-04-30&tick=7+days'

Response:

{
  "global_ppi": [
    {
      "tick": "2014-10-15T00:00:00.000+02:00",
      "global_ppi": "71.724394968569117126"
    },
    ...
    {
      "tick": "2015-10-15T00:00:00.000+02:00",
      "global_ppi": "51.110243502525189243"
    }
  ]
}

CSV Examples:

curl http://bitcoinppi.com/v1.1/global_ppi.csv

curl 'http://bitcoinppi.com/v1.1/global_ppi.csv?from=2011-07-01&to=2013-04-30'

curl 'http://bitcoinppi.com/v1.1/global_ppi.csv?from=2011-07-01&to=2013-04-30&tick=7+days'

Response:

tick,global_ppi
2015-11-14 00:00:00,99.606549
...

GET /countries

This endpoint returns all ppi values of all countries, over a defined time series. The timeframe can be adjusted using the GET parameters declared above. By default it returns data from the last year at a resolution of 1 day.

The default response type is JSON. To receive a CSV response, append .csv to the request path.

JSON Examples:

curl http://bitcoinppi.com/v1.1/countries

curl 'http://bitcoinppi.com/v1.1/countries?from=2014-07-01&to=2015-04-30'

curl 'http://bitcoinppi.com/v1.1/countries?from=2014-07-01&to=2015-04-30&tick=7+days'

Response:

{
  "countries": [
    {
      "time": "2015-10-15T10:44:12.000+02:00",
      "tick": "2015-10-15T00:00:00.000+02:00",
      "country": "DE",
      "currency": "EUR",
      "bitcoin_price": "221.75",
      "bigmac_price": "3.59",
      "weight": "0.03",
      "local_ppi": "61.7688022284122563",
      "avg_24h_local_ppi": "65.0716961723251063"
    },
    ...
    {
      "time": "2014-10-15T02:00:00.000+02:00",
      "tick": "2014-10-15T00:00:00.000+02:00",
      "country": "US",
      "currency": "USD",
      "bitcoin_price": "394.45",
      "bigmac_price": "4.8",
      "weight": "0.05",
      "local_ppi": "82.1770833333333333",
      "avg_24h_local_ppi": "56.7332445521559411"
    }
  ]
}

CSV Examples:

curl http://bitcoinppi.com/v1.1/countries.csv

curl 'http://bitcoinppi.com/v1.1/countries.csv?from=2014-07-01&to=2015-04-30'

curl 'http://bitcoinppi.com/v1.1/countries.csv?from=2014-07-01&to=2015-04-30&tick=7+days'

Response:

time,tick,country,currency,bitcoin_price,bigmac_price,weight,local_ppi
2015-11-14 11:58:23,2015-11-14 00:00:00,GB,GBP,227.0,2.89,0.025077,78.546713
...

GET /countries/:country

This endpoint returns all ppi values by country, over a defined time series. The part :country should be set as an uppercase ISO3166 alpha2 country code. The timeframe can be adjusted using the GET parameters declared above. By default it returns data from the last year at a resolution of 1 day.

The default response type is JSON. To receive a CSV response, append .csv to the request path.

JSON Examples:

curl http://bitcoinppi.com/v1.1/countries/DE

curl 'http://bitcoinppi.com/v1.1/countries/DE?from=2014-07-01&to=2015-04-30'

curl 'http://bitcoinppi.com/v1.1/countries/DE?from=2014-07-01&to=2015-04-30&tick=7+days'

Response:

{
  "DE": [
    {
      "time": "2015-10-15T10:44:12.000+02:00",
      "country": "DE",
      "currency": "EUR",
      "bitcoin_price": "221.75",
      "bigmac_price": "3.59",
      "weight": "0.03",
      "local_ppi": "61.7688022284122563",
      "tick": "2015-10-15T00:00:00.000+02:00",
      "avg_24h_local_ppi": "65.0716961723251063"
    },
    ...
    {
      "time": "2014-10-15T02:00:00.000+02:00",
      "country": "DE",
      "currency": "EUR",
      "bitcoin_price": "312.1",
      "bigmac_price": "3.67",
      "weight": "0.03",
      "local_ppi": "85.0408719346049046",
      "tick": "2014-10-15T00:00:00.000+02:00",
      "avg_24h_local_ppi": "65.0716961723251063"
    }
  ]
}

JSON Examples:

curl http://bitcoinppi.com/v1.1/countries/DE.csv

curl 'http://bitcoinppi.com/v1.1/countries/DE.csv?from=2014-07-01&to=2015-04-30'

curl 'http://bitcoinppi.com/v1.1/countries/DE.csv?from=2014-07-01&to=2015-04-30&tick=7+days'

Response:

time,tick,country,currency,bitcoin_price,bigmac_price,weight,local_ppi
2015-11-14 11:58:23,2015-11-14 00:00:00,DE,EUR,308.96,3.59,0.029394,86.061281
...