API response container

The response container is returned from every endpoint in the API. It defines certain meta-data about the API, along with relevant request limiting stats and either an error or the response data from the endpoint.

name

string

Always "SPP Container"

version

string

The API version, currently "0.2"

api

integer

The current API major version

object

string

The containing object type for the response

type

string

The sub-type of the response

code

integer

The HTTP response code

request

Request limiting status

Current request limiting status

meta

string

error

API Exception

data

object

The endpoint return value. See individual endpoint docs for details on what data is returned.

debug

API debug information

Request limiting status

reset

integer

The number of seconds until remaining will be reset to limit

limit

integer

The maximum number of allowed requests within the reset period (typically one hour)

remaining

integer

The number of remaining API requests in the current reset period

API debug information

route

API debug route

params

object

An object of request parameters where the parameter names are property names and parameter values are property values.

API debug route

name

string

url

string

controller

string

API Exception

code

integer

The API error code

type

string

A textual representation of the kind of error that occurred

description

string

Further details about the error

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.