Running Queries

The Empire Avenue API is a RESTful API. As such you can make queries against the API to the any of our end points (URLs) using any client which can make HTTP or Web requests. Typically you can use cURL to connect with our API. Parameters are passed along as either GET or POST. GET is typically to obtain data from the API and POST is typically to write data onto the servers. For example, you would GET a list of followers and you would POST a new follower for someone.

End Points

All queries must be directed at URL "end points" which basically run the query you require, for example, the end point for to obtain the profile information of a user is:

https://api.empireavenue.com/profile/info

You must be able to make SSL connections to the API server

Standard Parameters

All queries to the Empire Avenue API must contain at the very least the following parameters:

//Every query must contain your API Key. Without your API Key, your request will be discarded //apikey={your api key} apikey=16c770cc1d8485fb2f97df51d8dfa7be7ed79b618aa176b587

Returned Data

All data, including errors returned by the Empire Avenue API is in the JSON format. Each page in the API documentation will show sample outputs and fields for what you should expect from a call to the API.

The following "meta" data is returned with each call

//The following is an example of data returned with every call "meta": { "requested_user": (int) user_id "total_rows": (int) rows "uri": (string) URI "limit": (int) Maximum Limit For This Call "limit_type": (string) Either "user" or "ip" "requests": (int) Requests made since last Limit Reset "reset": (int) Number of seconds to next Reset "recorded": (string) Datetime stamp in GMT for this call }