Publishers: API
Heyzap Publishers API Documentation
Methods
get_games: Get a set of games ordered by popularity or a particular game (default method)
get_random_game: Get one random game
get_category_list: Get back a list of Heyzap categories
'embed_key' and 'secret_key' is a required parameter for length above 10. Others are optional
| Parameter | Permissable Values | Default | Description |
| method | get_game | get_game | API method |
| embed_key | null | embed_key identifies your site. This is required for calls for length > 10 | |
| secret_key | null | Keep this key secret. This is required for calls for length > 10 | |
| search_query | String: Comma separated query terms | null | Leave blank to get all games. If not blank only games with that satisfy search_query will be returned |
| length | Integer: 0-1000 | 1 | How many games to return |
| offset | Integer: 0-1000 | 0 | Returns from a position offset*length. This can be used for pagination |
| permalink | String: Game name as a permalink (e.g. permalink=desktop-tower-defense) | null | If given the game is searched for and if found only one game is returned |
| category | String: Category name (in long or short form. see get_category_list method) | popular | If given only games in that category are returned. (New returns games ordered by newest first) |
| thumb_width | 32, 50, 75, 112, 100, 200, 250, 250, 350, 480 | 350 | Width of bigThumb returned |
| thumb_height | 32, 50, 75, 93, 100, 200, 200, 250, 350, 360 | 350 | Height of bigThumb returned |
| max_width | Integer: 1-1000 | 700 | Determine the maximum width the embed code returned should be |
| max_height | Integer: 1-1000 | 700 | Determine the maximum height the embed code returned can be |
| Parameter | Permissable Values | Default | Description |
| method | get_game | get_game | API method |
| embed_key | null | embed_key identifies your site. This is required for calls for length > 10 | |
| secret_key | null | Keep this key secret. This is required for calls for length > 10 | |
| thumb_width | 32, 50, 75, 112, 100, 200, 250, 250, 350, 480 | 350 | Width of bigThumb returned |
| thumb_height | 32, 50, 75, 93, 100, 200, 200, 250, 350, 360 | 350 | Height of bigThumb returned |
| max_width | Integer: 1-1000 | 700 | Determine the maximum width the embed code returned should be |
| max_height | Integer: 1-1000 | 700 | Determine the maximum height the embed code returned can be |
| Parameter | Permissable Values | Default | Description |
| method | get_game | get_game | API method |
| embed_key | null | embed_key identifies your site. This is required for calls for length > 10 | |
| secret_key | null | Keep this key secret. This is required for calls for length > 10 |
Examples
By using Heyzap, you confirm that you agree to the Terms of Service.
