Heyzap API Overview

This API gives you access to most of the data Heyzap makes available on our Android and iOS applications, including games, activity and users on the Heyzap network.

The API aims to be self-documenting, and you can immediately begin exploring from the root of the API.

curl -i http://www.heyzap.com/api/v1/

API responses are currently JSON and JSONP only. Currently the API is read-only, all API calls should be made with HTTP GET. To use JSONP add callback=name to the end of any request URL.

The API comprises of three parts: Games, Activity and Users, described below.


For API responses that support pagination, the url to the next page of data can be found inside the next_page_url value at the root of the response.

Rate Limits

The Heyzap API is currently rate limited to 5,000 requests per IP per hour. Please email us at support@heyzap.com if you have a specific use case that requires a higher rate limit.

The following HTTP headers in the response show your current API rate limit usage:

$ curl -i http://www.heyzap.com/api/v1/games

HTTP/1.1 200 OK
Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

Games API

Games are the central point for Heyzap's data, you can fetch activity around a game, see who is playing and browse discussions or checkins.

You can explore and traverse games from the root of the Games API.

curl -i http://www.heyzap.com/api/v1/games/

Or read the full Games API documentation.

Users API

The Users API contains information about users on the Heyzap network, you can fetch a user's activity, see which games they are playing and browse their discussions or checkins.

You can explore and traverse games from the root of the Users API.

curl -i http://www.heyzap.com/api/v1/users/

Or read the full Users API documentation.

Activity API

The Activity API allows you to fetch and explore global Heyzap activity streams for both the android and ios platforms.

You can explore and traverse games from the root of the Activity API.

curl -i http://www.heyzap.com/api/v1/activity/

Or read the full Activity API documentation.

Terms of Use

This API is intended for non-commercial usage. If ever showing a Heyzap user profile link through to that users weburl on Heyzap. If showing a game you should link through to the games weburl on Heyzap. Additionally attribute the usage of the API from Heyzap.com and link through to http://www.heyzap.com whereever the API is used.

Usage of the API outside the above parameters is not allowed without explicit permission from Heyzap. Pelase email us at support@heyzap.com if you have another use case in mind.

Our normal Terms of Service also apply when using the API.