Developers ยป Advanced API
close

Advanced API Overview

This API lets allows developers to create, read, update and delete private data from Official.fm. It requires an oAuth identification.
Simple API paths are all available in advanced API.

URL structure

Simple API paths are all available in advanced API.

To execute advanced API actions, you must send POST/PUT/DELETE requests with this following structure :

http://api.official.fm/path with oauth parameters and optional parameters

Parameters

OAuth parameters

The Advanced API requires every request to be authenticated with OAuth. Thus, you must include the following parameters in every request:

Description
oauth_consumer_key Your application's API key
oauth_nonce A randomly-generated string that is unique to each API call. This, along with the timestamp, is used to prevent replay attacks.
oauth_signature_method The cryptographic method used to sign the call. Official.fm Advanced API only supports HMAC-SHA1.
oauth_timestamp The number of seconds that have elapsed since midnight, January 1, 1970, also known as UNIX time. Make sure this timestamp is within 10 minutes of the actual time, or the request will fail.
oauth_version Optional, but if you include it, it must be 1.0. It's a good idea to include it anyway, because the OAuth spec may change in the future.

optional parameters

Some requests accept additional requests, such as email, city, etc. OAuth parameters described above are required for all requests.

The following parameters are accepted for all requests:

Example values Description
format json, xml Desired format for server responses (Default: XML)
callback handle_response JavaScript callback to use in a JSONP response.
Use only with format=json
Top
top