The Basics

These rules apply to every request you make to the Appfigures API.

The API Is Entirely HTTP-Based

Use GET to retrieve data, POST to add records, and PUT to edit them. Use DELETE to remove data. If a method requires a specific HTTP verb and you send a different one, you’ll get an error.

Important: You can’t undo a DELETE.

The API Is Stateless

The API doesn’t keep state between requests, so every request needs authentication.

Security

The API supports OAuth and HTTP Authentication. See Authentication for details. You’ll need a Client Key to get started.

The API only accepts requests over HTTPS (SSL). Requests over HTTP will fail.

Encoding

All API responses are UTF-8 encoded.

Dates & Time Zones

Dates in requests and responses use the sortable year-month-day format (for example, 2017-04-12). You can also use date offsets relative to today:

• n, -n: n days in the future or past (-2 – two days ago, 4 – 4 days from now)
• nw, -nw, w: n weeks in the future or past (-2w – two weeks ago, w – last week, 4w – 4 weeks from now)
• The same pattern works for months (m) and years (y).

Dates fall into three categories, and each uses a different time zone.

Revenue Reports

Downloads, revenue, and ad reports are usually reported without a time zone and normalized into a single date.

Ranks Reports

Ranks reports always use the time zone the user selected. You can get it from the /users resource. The default is US Eastern Time (ET).

Everything Else

All other dates use US Eastern Time (ET).

There’s a Limit on API Calls

Each account gets a fixed number of API calls every day. See Rate Limits for the number and how to raise it.

The API Is Available to All of Our Members

Every member can use the API, regardless of plan or user role. You can access everything that’s available in your Appfigures account.