We've written some example scripts in PHP and Ruby in case you find it hard to get started. It's very basic though.
For each country that we operate in, our API is accessed through a different host. You'll need a separate API key for each host.
We provide both XML and JSON formatted data. Pick your preferred output format by changing the extension of your request to either
For brevity we've used only XML output in the examples in this documentation
While using our API you can encounter the following response status codes:
||The request was correct|
||You either tried to request an invalid resource, or used a parameter incorrectly|
||You need to supply valid authentication credentials (ie. an API key)|
||You don't have the right privileges to access this method|
||The resource that you try to reach does not exist|
||Something went wrong on our side|
Authentication is fairly simple with an API key that you can request from us. Please append your API key to every request you make, e.g.
Please be aware that we've capped the amount of requests you can make to our API to 4000 requests per hour.
Not all data is accessible through the API. We currently recognize two different access levels:
mediapartner, meaning minipartners have restriced access to some fields.
Personal data is never accessible through our API.
All the requests that have multiple results are paginated. You can set the page size by adding the
size parameter to your request, e.g. to return 12 items per page, make the following request:
You can set the page you need with the
offset parameter, e.g. to get the third page of a list of institutes, using a page size of 12 institutes per page, make the following request:
||Used to indicate starting point of pagination|
||Number of results per page|