Giphy API Documentation
The Giphy API is now open to the public. We have institued a simple, single public beta key system to let anyone quickly hack and experiment with the API. An API key is required for all endpoints.
Giphy is an animated GIF search engine. If you would like to use Giphy API in production, please contact [email protected] or [email protected] for a unique API key.
Overview
The Giphy API provides nine JSON endpoints:
- recent
- translate
- search
- flagged
- favorites
- artists
- gif by id
- gifs by id
- screensaver
The search endpoint replicates the search found on Giphy. Translate is an experimental endpoint designed to be used for GIF dialects and screensaver returns a random gif. Learn more about the rest in the documentation below.
The Giphy API implements a REST-like interface. Connections can be made with any HTTP enabled programming language. The Giphy API also implements CORS, allowing you to connect to Giphy from JavaScript / Web browsers on your own domain.
Host
api.giphy.com
Parameters
- api_key - The public beta key is "dc6zaTOxFJmzC"
Recent GIFs Endpoint
Fetch most recent gifs, optionally limited by tag. Returns 10 results. Additional GIF size data can be looked up by using the get GIF by id.
http://api.giphy.com/v1/gifs/recent?api_key=dc6zaTOxFJmzC
Example recent GIFs query. Example recent GIFs by ryan gosling tag query.
Path
/v1/gifs/recent
Parameters
- tag (optional) limits recent GIFs to a specific tag.
- limit (optional) limits the number of results returned.
Sample Response, Recent
{
"data": [
{
"id": "jJgZWn8Z2z4Bi",
"images": {
"fixed_height": {
"height": "200",
"url": "http://media.giphy.com/media/jJgZWn8Z2z4Bi/200.gif",
"width": "220"
},
"fixed_height_still": {
"height": "200",
"url": "http://media.giphy.com/media/jJgZWn8Z2z4Bi/200_s.gif",
"width": "220"
},
"original": {
"height": "260",
"url": "http://media.giphy.com/media/jJgZWn8Z2z4Bi/giphy.gif",
"width": "286"
}
},
"type": "gif",
"update_date": "2013-06-19T01:54:14+00:00",
"url": "http://giphy.com/gifs/jJgZWn8Z2z4Bi"
}
],
"meta": {
"msg": "OK",
"status": 200
}
}
Translate Endpoint
This is prototype endpoint for using Giphy as a translation engine for a GIF dialect. The translate API draws on search, but uses the Giphy "special sauce" to handle translating from one vocabulary to another. In this case, words to GIFs.
http://api.giphy.com/v1/gifs/translate?s=superman&api_key=dc6zaTOxFJmzC&limit=1
Example translate query.
Path
/v1/gifs/translate
Parameters
- s - term or phrase to translate into a gif
Sample Response, Translate
{
"data": {
"bitly_fullscreen_url": "http://gph.is/XH7Sri",
"bitly_gif_url": "http://gph.is/XH7V6j",
"bitly_tiled_url": "http://gph.is/XH7Srk",
"id": "3avUsGhmckIYE",
"images": {
"fixed_height": {
"height": "200",
"url": "http://media.giphy.com/media/3avUsGhmckIYE/200.gif",
"width": "289"
},
"fixed_height_downsampled": {
"height": "200",
"url": "http://media.giphy.com/media/3avUsGhmckIYE/200_d.gif",
"width": "289"
},
"fixed_height_still": {
"height": "200",
"url": "http://media.giphy.com/media/3avUsGhmckIYE/200_s.gif",
"width": "289"
},
"fixed_width": {
"height": "138",
"url": "http://media.giphy.com/media/3avUsGhmckIYE/200w.gif",
"width": "200"
},
"fixed_width_downsampled": {
"height": "138",
"url": "http://media.giphy.com/media/3avUsGhmckIYE/200w_d.gif",
"width": "200"
},
"fixed_width_still": {
"height": "138",
"url": "http://media.giphy.com/media/3avUsGhmckIYE/200w_s.gif",
"width": "200"
},
"original": {
"height": "346",
"url": "http://media.giphy.com/media/3avUsGhmckIYE/giphy.gif",
"width": "500"
}
},
"type": "gif",
"url": "http://giphy.com/gifs/3avUsGhmckIYE"
},
"meta": {
"msg": "OK",
"status": 200
}
}
Search Endpoint
Search all Giphy GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a hyphen for phrases. Example paul-rudd, ryan-gosling or american-psycho. Search terms should be URL encoded.
http://api.giphy.com/v1/gifs/search?q=funny+cat&api_key=dc6zaTOxFJmzC
Example search query.
Path
/v1/gifs/search
Parameters
- q - search query term or phrase
- limit - (optional) number of results to return, maximum 100. Default 25
- offset - (optional) results offset, defaults to 0
Sample Response, Search
{
"data": [
{
"bitly_fullscreen_url": "http://gph.is/XJIocS",
"bitly_gif_url": "http://gph.is/XJIp0f",
"bitly_tiled_url": "http://gph.is/XJIr8i",
"id": "iU1NUdMq3sx3O",
"images": {
"fixed_height": {
"height": "200",
"url": "http://media0.giphy.com/media/iU1NUdMq3sx3O/200.gif",
"width": "267"
},
"fixed_height_downsampled": {
"height": "200",
"url": "http://media0.giphy.com/media/iU1NUdMq3sx3O/200_d.gif",
"width": "267"
},
"fixed_height_still": {
"height": "200",
"url": "http://media0.giphy.com/media/iU1NUdMq3sx3O/200_s.gif",
"width": "267"
},
"fixed_width": {
"height": "150",
"url": "http://media0.giphy.com/media/iU1NUdMq3sx3O/200w.gif",
"width": "200"
},
"fixed_width_downsampled": {
"height": "150",
"url": "http://media0.giphy.com/media/iU1NUdMq3sx3O/200w_d.gif",
"width": "200"
},
"fixed_width_still": {
"height": "150",
"url": "http://media0.giphy.com/media/iU1NUdMq3sx3O/200w_s.gif",
"width": "200"
},
"original": {
"frames": "3",
"height": "375",
"size": "189975",
"url": "http://media0.giphy.com/media/iU1NUdMq3sx3O/giphy.gif",
"width": "500"
}
},
"type": "gif",
"url": "http://giphy.com/gifs/iU1NUdMq3sx3O"
}
],
"meta": {
"msg": "OK",
"status": 200
},
"pagination": {
"count": 1,
"offset": "0",
"total_count": 249
}
}
Flagged Endpoint (read)
The flagged endpoint is the first read and write endpoint on the Giphy API. The flagged read, GET, returns GIFs flagged as NSFW for this api_key. See format for the write endpoint, below.
http://api.giphy.com/v1/gifs/flagged?api_key=dc6zaTOxFJmzC
Example flagged read query
Path
/v1/gifs/flagged
Sample Response, Flagged (read)
{
"data": [
{
"api_key": "dc6zaTOxFJmzC",
"create_date": "2013-06-21 11:59:37",
"gif_id": "m5QHf0caAwgMw",
"is_inappropriate": "1",
"is_wrong_source": "0",
"source_corrected": ""
}
],
"meta": {
"msg": "OK",
"status": 200
},
"pagination": {
"count": 1,
"offset": 0,
"total_count": 1
}
}
Flagged Endpoint (write)
The flagged write, POST, endpoint accepts an ID to flag, and returns a list of flagged GIF id by this api_key
POST http://api.giphy.com/v1/gifs/m5QHf0caAwgMw/flagged?api_key=dc6zaTOxFJmzC
Path
/v1/gifs/<gif_id>/flagged
Sample Response, Flagged (write)
{
"data": {
"api_key": "dc6zaTOxFJmzC",
"create_date": "2013-06-21 12:09:09",
"gif_id": "m5QHf0caAwgMw",
"is_inappropriate": false,
"is_wrong_source": false,
"source_corrected": ""
},
"meta": {
"msg": "OK",
"status": 200
}
}
Favorites Endpoint (read)
The favorites endpoint allows favoriting by api_key. Favoriting supports both read and write, POST and GET.
http://api.giphy.com/v1/gifs/favorites?api_key=dc6zaTOxFJmzC
Example favorites, read, query
Path
/v1/gifs/favorites
Sample Response, Favorites (read)
{
"data": [
{
"api_key": "dc6zaTOxFJmzC",
"create_date": "2013-06-21 11:51:46",
"gif_id": "12HoHdqnDxz5NS",
"tag": ""
}
],
"meta": {
"msg": "OK",
"status": 200
},
"pagination": {
"count": 1,
"offset": 0,
"total_count": 1
}
}
Favorites Endpoint (write)
The write, POST, endpoint for favorites. Lookup additional GIF size data using the get GIF by ID endpoint.
POST http://api.giphy.com/v1/gifs/12HoHdqnDxz5NS/favorites?api_key=dc6zaTOxFJmzC
Path
/v1/gifs/<gif_id>/favorites
Sample Response, Favorites (write)
{
"data": {
"api_key": "dc6zaTOxFJmzC",
"create_date": "2013-06-21 11:51:46",
"gif_id": "12HoHdqnDxz5NS",
"tag": ""
},
"meta": {
"msg": "OK",
"status": 200
}
}
Screensaver Endpoint
Returns a random gif, limited by tag. Excluding the tag parameter will return a random gif from the Giphy catalog.
http://api.giphy.com/v1/gifs/screensaver?api_key=dc6zaTOxFJmzC&tag=american-psycho
Example screensaver query
Path
/v1/gifs/screensaver
OR
/v1/gifs/random
Parameters
- tag - the gif tag to limit randomness by
Sample Response, Screeensaver
{
"data": {
"id": "12jp1Z7ITCrPxe",
"image_original_url": "http://media.giphy.com/media/12jp1Z7ITCrPxe/giphy.gif"
},
"meta": {
"msg": "OK",
"status": 200
}
}
Artists Endpoint
Return a list of Giphy GIF artists, the optional username parameter limits the response to GIFs created by artist username. Support pagination via limit and offset parameters.
http://api.giphy.com/v1/gifs/artists?api_key=dc6zaTOxFJmzC
Example artist query Example GIFs by artist, mrdiv
Path
/v1/gifs/artists
Parameters
- username (optional) limits response to GIFs created by artist
- limit (optional) limits the results returned. Max is 100
- offset (optional) start position in results. Defaults to 0
Sample Response, Artists
{
"data": [
{
"avatar": "http://media.giphy.com/avatars/mrdiv.gif",
"count": 61,
"name": "mr. div",
"username": "mrdiv",
"website": "http://mrdiv.tumblr.com/"
}
...
],
"meta": {
"msg": "OK",
"status": 200
},
"pagination": {
"count": 26,
"offset": 0,
"total_count": 26
}
}
Sample Reponse, Artist - mrdiv
{
"data": [
{
"bitly_fullscreen_url": "http://gph.is/13YkU2A",
"bitly_gif_url": "http://gph.is/13YkU2y",
"bitly_tiled_url": "http://gph.is/13YkTf4",
"embed_url": "http://giphy.com/embed/7rzbxdu0ZEXLy",
"id": "7rzbxdu0ZEXLy",
"images": {
"fixed_height": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200.gif",
"width": "200"
},
"fixed_height_downsampled": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200_d.gif",
"width": "200"
},
"fixed_height_still": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200_s.gif",
"width": "200"
},
"fixed_width": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200w.gif",
"width": "200"
},
"fixed_width_downsampled": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200w_d.gif",
"width": "200"
},
"fixed_width_still": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200w_s.gif",
"width": "200"
},
"original": {
"frames": "9",
"height": "500",
"size": "1012692",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/giphy.gif",
"width": "500"
}
},
"type": "gif",
"url": "http://giphy.com/gifs/7rzbxdu0ZEXLy"
}
],
"meta": {
"msg": "OK",
"status": 200
},
"pagination": {
"count": 1,
"offset": null,
"total_count": 61
}
}
Get GIF by ID Endpoint
Returns meta data about a gif, by gif id. In the below example, the gif ID is "feqkVgjJpYtjy"
http://api.giphy.com/v1/gifs/feqkVgjJpYtjy?api_key=dc6zaTOxFJmzC
Example get gif by id query
Path
/v1/gifs/<gif_id>
Sample Response, Get GIF by ID
{
"data": {
"bitly_fullscreen_url": "http://gph.is/XJ1Y8Q",
"bitly_gif_url": "http://gph.is/XJ200y",
"bitly_tiled_url": "http://gph.is/XJ1Y8T",
"id": "feqkVgjJpYtjy",
"images": {
"fixed_height": {
"height": "200",
"url": "http://media.giphy.com/media/feqkVgjJpYtjy/200.gif",
"width": "445"
},
"fixed_height_downsampled": {
"height": "200",
"url": "http://media.giphy.com/media/feqkVgjJpYtjy/200_d.gif",
"width": "445"
},
"fixed_height_still": {
"height": "200",
"url": "http://media.giphy.com/media/feqkVgjJpYtjy/200_s.gif",
"width": "445"
},
"fixed_width": {
"height": "90",
"url": "http://media.giphy.com/media/feqkVgjJpYtjy/200w.gif",
"width": "200"
},
"fixed_width_downsampled": {
"height": "90",
"url": "http://media.giphy.com/media/feqkVgjJpYtjy/200w_d.gif",
"width": "200"
},
"fixed_width_still": {
"height": "90",
"url": "http://media.giphy.com/media/feqkVgjJpYtjy/200w_s.gif",
"width": "200"
},
"original": {
"height": "150",
"url": "http://media.giphy.com/media/feqkVgjJpYtjy/giphy.gif",
"width": "334"
}
},
"type": "gif",
"url": "http://giphy.com/gifs/feqkVgjJpYtjy"
},
"meta": {
"msg": "OK",
"status": 200
}
}
Get GIFs by ID Endpoint
A multiget version of the get GIF by ID endpoint. In this case the IDs are feqkVgjJpYtjy and 7rzbxdu0ZEXLy
http://api.giphy.com/v1/gifs?api_key=dc6zaTOxFJmzC&ids=feqkVgjJpYtjy,7rzbxdu0ZEXLy
Example get GIFs by Id
Path
/v1/gifs
Parameters
- ids - a comma separated list of IDs to fetch GIF size data
Sample Response, Get GIFs by ID
{
"data": [
{
"bitly_fullscreen_url": "http://gph.is/13YkU2A",
"bitly_gif_url": "http://gph.is/13YkU2y",
"bitly_tiled_url": "http://gph.is/13YkTf4",
"embed_url": "http://giphy.com/embed/7rzbxdu0ZEXLy",
"id": "7rzbxdu0ZEXLy",
"images": {
"fixed_height": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200.gif",
"width": "200"
},
"fixed_height_downsampled": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200_d.gif",
"width": "200"
},
"fixed_height_still": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200_s.gif",
"width": "200"
},
"fixed_width": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200w.gif",
"width": "200"
},
"fixed_width_downsampled": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200w_d.gif",
"width": "200"
},
"fixed_width_still": {
"height": "200",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/200w_s.gif",
"width": "200"
},
"original": {
"frames": "9",
"height": "500",
"size": "1012692",
"url": "http://media0.giphy.com/media/7rzbxdu0ZEXLy/giphy.gif",
"width": "500"
}
},
"type": "gif",
"url": "http://giphy.com/gifs/7rzbxdu0ZEXLy"
},
{
"bitly_fullscreen_url": "http://gph.is/XJ1Y8Q",
"bitly_gif_url": "http://gph.is/XJ200y",
"bitly_tiled_url": "http://gph.is/XJ1Y8T",
"embed_url": "http://giphy.com/embed/feqkVgjJpYtjy",
"id": "feqkVgjJpYtjy",
"images": {
"fixed_height": {
"height": "200",
"url": "http://media3.giphy.com/media/feqkVgjJpYtjy/200.gif",
"width": "445"
},
"fixed_height_downsampled": {
"height": "200",
"url": "http://media2.giphy.com/media/feqkVgjJpYtjy/200_d.gif",
"width": "445"
},
"fixed_height_still": {
"height": "200",
"url": "http://media0.giphy.com/media/feqkVgjJpYtjy/200_s.gif",
"width": "445"
},
"fixed_width": {
"height": "90",
"url": "http://media1.giphy.com/media/feqkVgjJpYtjy/200w.gif",
"width": "200"
},
"fixed_width_downsampled": {
"height": "90",
"url": "http://media0.giphy.com/media/feqkVgjJpYtjy/200w_d.gif",
"width": "200"
},
"fixed_width_still": {
"height": "90",
"url": "http://media2.giphy.com/media/feqkVgjJpYtjy/200w_s.gif",
"width": "200"
},
"original": {
"frames": "27",
"height": "150",
"size": "511581",
"url": "http://media3.giphy.com/media/feqkVgjJpYtjy/original.gif",
"width": "334"
}
},
"type": "gif",
"url": "http://giphy.com/gifs/feqkVgjJpYtjy"
}
],
"meta": {
"msg": "OK",
"status": 200
},
"pagination": {
"count": 2,
"offset": 0,
"total_count": 2
}
}
Code Examples
Below are code samples in Python, JavaScript, Ruby, PHP and the command line on connecting to the API to make a search query for ryan gosling.
Python scripting language
# python
import urllib,json
data = json.loads(urllib.urlopen("http://api.giphy.com/v1/gifs/search?q=ryan-gosling&api_key=dc6zaTOxFJmzC&limit=5").read())
print json.dumps(data, sort_keys=True, indent=4)
JavaScript scripting language
#javascript, jQuery
var xhr = $.get("http://api.giphy.com/v1/gifs/search?q=ryan-gosling&api_key=dc6zaTOxFJmzC&limit=5");
xhr.done(function(data) { console.log("success got data", data); });
Ruby scripting language
#ruby
require 'net/http'
require 'json'
url = "http://api.giphy.com/v1/gifs/search?q=ryan-gosling&api_key=dc6zaTOxFJmzC&limit=5"
resp = Net::HTTP.get_response(URI.parse(url))
buffer = resp.body
result = JSON.parse(buffer)
print result
PHP scripting language
// php
$url = "http://api.giphy.com/v1/gifs/search?q=ryan-gosling&api_key=dc6zaTOxFJmzC&limit=5";
print_r(json_decode(file_get_contents($url)));
Command line, cURL
# curl, command line
curl "http://api.giphy.com/v1/gifs/search?q=ryan-gosling&api_key=dc6zaTOxFJmzC&limit=5"
Sharing and Promoting your Giphy API Project
Projects that leverage the Giphy API can be submitted to Giphy labs. Learn more about Giphy labs.
Additional Information
Please submit corrections via github issues. Please see the terms for any restrictions on using the service.
Note: the public beta key will be decommissioned at a point in the future. Usage in production is prohibited and not recommended. Developers seeking to leverage the Giphy API should contact [email protected] or [email protected] for a unique API key.