Responses

The PredictHQ API will respond to successful requests with either a collection of records or a single record. This section describes the standard format for each record type. Refer to the Resources section for a description of the results for each endpoint.

Headers

Content Negotiation

The PredictHQ API will always respond with the Content-Type header set to the format requested via the Accept header. Requests for a format not supported by the API will be rejected with the 406 Not Acceptable status code.

Content-Type: application/json

Collections

When requesting a collection of records, the JSON object will always contain the following properties:

Property	Description
count	The total number of results.
previous	A URL to the previous page, or `null` if this is the first page.
next	A URL to the next page, or `null` if this is the last page.
results	An array of records.

{
  "count": 189,
  "previous": null,
  "next": "https://api.predicthq.com/v1/endpoint/?offset=10&limit=10",
  "results": [
    {
        // record 1
    },
    {
        // record 2
    }

    // more records

  ]
}

Records

When requesting a single record, it will be returned as a JSON object. Refer to the Resources section for a description of possible records.

{
  "id": "e5c55724e854289204",
  "title": "Katy Perry",
  "description": " A world class, indoor, multi-purpose, all weather arena attracting the cream of world sports and entertainment ...",
  "category": "entertainement-concert",
  "start": "2014-12-19T06:00:00Z",
  "end": "2014-12-19T06:00:00Z",
  "timezone": "Pacific/Auckland",
  "duration": 0,
  "rank": 50,
  "country": "NZ",
  "location": [
    174.776792,
    -36.847319
  ],
}

Developer Documentation