REST API Documentation

API v1

gwitr's RESTFul API allows you to create an interface to communicate with gwitr's website. Your application can use gwitr's API to search, upload, create and view virtual gifts. Our API uses the OAuth Echo authentication method created by Twitter.

Register

Get API access and integrate gwitr into your application.

register_button

Methods

Rate Limiting

All requests to gwitr's API are rate-limited in order to prevent abusing our services. The current limit is 250 API requests per hour per IP address.

You can monitor the status of the current rate limit by inspecting the HTTP response headers that are returned. You should check the following :
X-RateLimit-Limit
X-RateLimit-Remaining

If you think your application will be exceeding the current rate limit, please contact us with all the necessary information and we may be able to whitelist your IP.

Feature-Based Rate Limiting

The upload_and_create_gift method has an additional feature rate limit which is applied in conjunction with the main REST API rate limit. An authenticated user can upload a maximum of 10 files (gift image) only per day. You can monitor the status of the feature rate limit by inspecting the HTTP response headers that are returned.

In addition to the default rate limit headers you will also see:

X-UploadRateLimit-Limit
X-UploadRateLimit-Remaining