Data-API

All calls to the Hyves API should be made to data.hyves-api.nl. Parameters to the Hyves API should be sent either in the POST body (url encoded), or in the query string. The oAuth parameters may be in the Authorization-HTTP-header, as described in the oAuth specification. The result can be returned in 4 different formats: XML, JSON, XMLP and JSONP. All formats contain exactly the same information, just in other formats. See for more information the ha_format parameter. Each call should be signed with an oauth_signature. For compatibility with the oauth specification, certain methods can enforce an urlencoded response; see the section on oAuth for more information.

Hyves API only accepts HTTP 1.1 calls, HTTP 1.0 calls will return an exception since they are outside the specification. Calls should either be GET or POST. The preferred method of calling is containing all the oAuth parameters in the Authorization header, and all other parameters in the POST body (per the oAuth specification). Since the API version 2.1 we also support HTTPS for all methods. Older versions only support HTTPS calls for auth.* methods.

The parameters necessary to do an API call, fall into three groups. Firstly, there are the global Hyves API parameters, starting with ha_. Secondly, each call should contain the required oAuth parameters, which start with oauth_ (even calls that do not require authorization as a specific user). Finally, many methods define required or optional parameters, more information can be found in the method documentation.

You will find the Hyves API terms of use here.

Do you want to use the Hyves API for commercial use? Have a look here.