Git Product home page Git Product logo

giphyapi's Introduction

API Giphy logo

Giphy API Documentation

Giphy is an animated GIF search engine.

Access and API Keys

Public Beta Key

The Giphy API is open to the public. We have instituted a simple, single public beta key system to let anyone try it out. The API key is required for all endpoints.

  • The public beta key is "dc6zaTOxFJmzC”

Please use this key while you develop your application and experiment with your integrations. Note: the public key is subject to rate limit constraints and we do not encourage live production deployments to use the public key.

Request a Production Key

Once you’re ready to use the Giphy API in production, please visit api.giphy.com/submit to request a production API key. In your submission, please be prepared to provide the following:

  • Your app name with brief description, web / app store links, etc.

  • The 'live date' of the app and feature that integrates with the API. Briefly describe how the Giphy API integrates with your app and provide screenshots of the implementation.

  • As per our section 5 A of our terms of service, we require all apps that use the Giphy API to conspicuously display "Powered By Giphy" attribution marks where the API is utilized. You can find approved official logo marks here. Please provide screenshots of your attribution placement.

If you have any questions please feel free to contact us at [email protected]. Please submit API corrections via github issues. Please see our terms of service for any restrictions on using the service. We also recommend using the JSONview plugin for Firefox or Chrome to view the API responses in your browser.

Overview

The public Giphy API provides the following JSON read and write endpoint(s):

######READ ENDPOINTS

######WRITE ENDPOINT

GIPHY's GIF libary is the largest in the world and includes millions of original GIFs directly from the world's best content partners, original GIF artists, as well as the best GIFs from across the entire internet. GIPHY's APIs make it dead simple for developers to incorporate this vast library right inside of their apps to deliver highly interactive content that is proven to increase daily engagement across all types of apps; messaging, chat, dating, creation, community, and more.

Giphy Labs is a great place to see various implementations of the Giphy API. Learn more about the rest in the documentation below.

The Giphy API implements a REST-like interface. Connections can be made with any HTTP or HTTPS enabled programming language. The Giphy API also implements CORS, allowing you to connect to Giphy from JavaScript / Web browsers on your own domain. The Giphy API provides multiple file sizes, dimensions, and formats of every GIF to meet every clients potential needs. You can view a guide to the rendition offering here.

  • Search replicates the search found on Giphy.
  • Translate converts words and phrases to GIFs and is designed to be used in messaging apps, e.g. the Giphy Slack integration.
  • Trending pulls in the best GIFs from around the internet, hand curated by the Giphy editorial team.
  • Random returns a single random GIF, optionally limited to a specified tag.
  • Stickers are a separate library of animated, transparent GIFs; great for creation apps and iOS10 iMessage apps! You can also view them on the web by visiting giphy.com/stickers.
  • Upload allows you to upload your content programatically to Giphy!

Other features include:

  • 😎 Emoji support across Search, Translate, and Random endpoints!
  • Language support for 30+ languages - see langauge documentation here
  • Optimized renditions for mobile to deliver GIFs that load fast and consume less bandwidth - see rendition guide here
  • MP4s and Webps of every GIF!
  • MPAA rating filters supported across all endpoints
Host
api.giphy.com
Parameters
  • api_key - The public beta key is "dc6zaTOxFJmzC"

Search Endpoint

Search all Giphy GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases. Example paul+rudd, ryan+gosling or american+psycho.

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.
  • rating - (optional) limit results to those rated (y,g, pg, pg-13 or r).
  • lang - (optional) specify default country for regional content; format is 2-letter ISO 639-1 country code. See list of supported langauges here
  • fmt - (optional) return results in html or json format (useful for viewing responses as GIFs to debug/test)

Sample Response, Search

{
    "data": [
        {
        	type: "gif",
			id: "FiGiRei2ICzzG",
		    slug: "funny-cat-FiGiRei2ICzzG",
			url: "http://giphy.com/gifs/funny-cat-FiGiRei2ICzzG",
			bitly_gif_url: "http://gph.is/1fIdLOl",
			bitly_url: "http://gph.is/1fIdLOl",
			embed_url: "http://giphy.com/embed/FiGiRei2ICzzG",
			username: "",
			source: "http://tumblr.com",
			rating: "g",
			caption: "",
			content_url: "",
			source_tld: "tumblr.com",
			source_post_url: "http://tumblr.com",
			import_datetime: "2014-01-18 09:14:20",
			trending_datetime: "1970-01-01 00:00:00",
			images: {
				fixed_height: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/200.gif",
					width: "568",
					height: "200",
					size: "460622",
					mp4: "http://media2.giphy.com/media/FiGiRei2ICzzG/200.mp4",
					mp4_size: "13866",
					webp: "http://media2.giphy.com/media/FiGiRei2ICzzG/200.webp",
					webp_size: "367786"
				},
				fixed_height_still: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/200_s.gif",
					width: "568",
					height: "200"
				},
				fixed_height_downsampled: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/200_d.gif",
					width: "568",
					height: "200",
					size: "476276",
					webp: "http://media2.giphy.com/media/FiGiRei2ICzzG/200_d.webp",
					webp_size: "100890"
				},
				fixed_width: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/200w.gif",
					width: "200",
					height: "70",
					size: "90483",
					mp4: "http://media2.giphy.com/media/FiGiRei2ICzzG/200w.mp4",
					mp4_size: "14238",
					webp: "http://media2.giphy.com/media/FiGiRei2ICzzG/200w.webp",
					webp_size: "47302"
				},
				fixed_width_still: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/200w_s.gif",
					width: "200",
					height: "70"
				},
				fixed_width_downsampled: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/200w_d.gif",
					width: "200",
					height: "70",
					size: "71069",
					webp: "http://media2.giphy.com/media/FiGiRei2ICzzG/200w_d.webp",
					webp_size: "13186"
				},
				fixed_height_small: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/100.gif",
					width: "284",
					height: "100",
					size: "460622",
					webp: "http://media2.giphy.com/media/FiGiRei2ICzzG/100.webp",
					webp_size: "72748"
				},
				fixed_height_small_still: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/100_s.gif",
					width: "284",
					height: "100"
				},
				fixed_width_small: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/100w.gif",
					width: "100",
					height: "35",
					size: "90483",
					webp: "http://media2.giphy.com/media/FiGiRei2ICzzG/100w.webp",
					webp_size: "18298"
				},
				fixed_width_small_still: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/100w_s.gif",
					width: "100",
					height: "35"
				},
				downsized: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/giphy.gif",
					width: "500",
					height: "176",
					size: "426811"
				},
				downsized_still: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/giphy_s.gif",
					width: "500",
					height: "176"
				},
				downsized_large: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/giphy.gif",
					width: "500",
					height: "176",
					size: "426811"
				},
				original: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/giphy.gif",
					width: "500",
					height: "176",
					size: "426811",
					frames: "22",
					mp4: "http://media2.giphy.com/media/FiGiRei2ICzzG/giphy.mp4",
					mp4_size: "51432",
					webp: "http://media2.giphy.com/media/FiGiRei2ICzzG/giphy.webp",
					webp_size: "291616"
				},
				original_still: {
					url: "http://media2.giphy.com/media/FiGiRei2ICzzG/giphy_s.gif",
					width: "500",
					height: "176"
				}
			}
        },
        ... 24 more items
    ],
    "meta": {
        "status": 200,
        "msg": "OK"
    },
    "pagination": {
        "total_count": 1947,
        "count": 25,
        "offset": 0
    }
}

Trending GIFs Endpoint

Fetch GIFs currently trending online. Hand curated by the Giphy editorial team. The data returned mirrors the GIFs showcased on the Giphy homepage. Returns 25 results by default.

http://api.giphy.com/v1/gifs/trending?api_key=dc6zaTOxFJmzC

Example trending GIFs query. Example trending GIFs limited to 5 results.

Path
/v1/gifs/trending
Parameters
  • limit (optional) limits the number of results returned. By default returns 25 results.
  • rating - limit results to those rated (y,g, pg, pg-13 or r).
  • fmt - (optional) return results in html or json format (useful for viewing responses as GIFs to debug/test)

Sample Response, Trending

{
    data: [
        {
        type: "gif",
		id: "op7uqYWBm3R04",
		slug: "food-krush-groove-the-fat-boys-op7uqYWBm3R04",
		url: "http://giphy.com/gifs/food-krush-groove-the-fat-boys-op7uqYWBm3R04",
		bitly_gif_url: "http://gph.is/1FupHza",
		bitly_url: "http://gph.is/1FupHza",
		embed_url: "http://giphy.com/embed/op7uqYWBm3R04",
		username: "",
		source: "http://televandalist.com/post/104471085874",
		rating: "y",
		caption: "",
		content_url: "",
	    source_tld: "televandalist.com",
		source_post_url: "http://televandalist.com/post/104471085874",
		import_datetime: "2014-12-06 06:21:55",
		trending_datetime: "2015-04-01 16:05:01",
		images: {
				fixed_height: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/200.gif",
					width: "360",
					height: "200",
					size: "0",
					mp4: "http://media0.giphy.com/media/op7uqYWBm3R04/200.mp4",
					mp4_size: "367554",
					webp: "http://media0.giphy.com/media/op7uqYWBm3R04/200.webp",
					webp_size: "875414"
				},
				fixed_height_still: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/200_s.gif",
					width: "360",
					height: "200"
				},
				fixed_height_downsampled: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/200_d.gif",
					width: "360",
					height: "200",
					size: "140417",
					webp: "http://media0.giphy.com/media/op7uqYWBm3R04/200_d.webp",
					webp_size: "130658"
				},
				fixed_width: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/200w.gif",
					width: "200",
					height: "111",
					size: "0",
					mp4: "http://media0.giphy.com/media/op7uqYWBm3R04/200w.mp4",
					mp4_size: "342209",
					webp: "http://media0.giphy.com/media/op7uqYWBm3R04/200w.webp",
					webp_size: "327936"
				},
				fixed_width_still: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/200w_s.gif",
					width: "200",
					height: "111"
				},
				fixed_width_downsampled: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/200w_d.gif",
					width: "200",
					height: "111",
					size: "368276",
					webp: "http://media0.giphy.com/media/op7uqYWBm3R04/200w_d.webp",
					webp_size: "49460"
				},
				fixed_height_small: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/100.gif",
					width: "180",
					height: "100",
					size: "0",
					webp: "http://media0.giphy.com/media/op7uqYWBm3R04/100.webp",
					webp_size: "281042"
				},
				fixed_height_small_still: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/100_s.gif",
					width: "180",
					height: "100"
				},
				fixed_width_small: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/100w.gif",
					width: "100",
					height: "56",
					size: "0",
					webp: "http://media0.giphy.com/media/op7uqYWBm3R04/100w.webp",
					webp_size: "108110"
				},
				fixed_width_small_still: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/100w_s.gif",
					width: "100",
					height: "56"
				},
				downsized: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/giphy.gif",
					width: "400",
					height: "222",
					size: "2071771"
				},
				downsized_still: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/giphy_s.gif",
					width: "400",
					height: "222"
				},
				downsized_large: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/giphy.gif",
					width: "400",
					height: "222",
					size: "2071771"
				},
				original: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/giphy.gif",
					width: "400",
					height: "222",
					size: "2071771",
					frames: "41",
					mp4: "http://media0.giphy.com/media/op7uqYWBm3R04/giphy.mp4",
					mp4_size: "928142",
					webp: "http://media0.giphy.com/media/op7uqYWBm3R04/giphy.webp",
					webp_size: "1004522"
				},
				original_still: {
					url: "http://media0.giphy.com/media/op7uqYWBm3R04/giphy_s.gif",
					width: "400",
					height: "222"
				}
			}
         },
        ... 24 more items here 
    ],
    pagination: {
        count: 25,
        offset: 0
    },
    meta: {
        status: 200,
        msg: "OK"
    }
}

Translate Endpoint

The translate API draws on search, but uses the Giphy "special sauce" to handle translating from one vocabulary to another. In this case, words and phrases to GIFs. Example implementations of translate can be found in the Giphy Slack, Hipchat, Wire, or Dasher integrations. Use a plus or url encode for phrases.

http://api.giphy.com/v1/gifs/translate?s=superman&api_key=dc6zaTOxFJmzC

Example translate query.

Path
/v1/gifs/translate
Parameters
  • s - term or phrase to translate into a GIF
  • rating - (optional) limit results to those rated (y,g, pg, pg-13 or r).
  • lang - (optional) specify default country for regional content; format is 2-letter ISO 639-1 country code. See list of supported langauges here
  • fmt - (optional) return results in html or json format (useful for viewing responses as GIFs to debug/test)

Sample Response, Translate

{
    "data": {
        type: "gif",
		id: "wWAIKcFASEFz2",
	    slug: "superman-santa-chandler-bing-wWAIKcFASEFz2",
		url: "http://giphy.com/gifs/superman-santa-chandler-bing-wWAIKcFASEFz2",
		bitly_gif_url: "http://gph.is/XMD6gE",
		bitly_url: "http://gph.is/XMD6gE",
		embed_url: "http://giphy.com/embed/wWAIKcFASEFz2",
		username: "",
		source: "http://daytripperrevolution.tumblr.com/post/13729531842",
		rating: "g",
		caption: "",
		content_url: "",
		source_tld: "daytripperrevolution.tumblr.com",
		source_post_url: "http://daytripperrevolution.tumblr.com/post/13729531842",
		import_datetime: "2013-03-24 17:48:35",
		trending_datetime: "1970-01-01 00:00:00",
		images: {
			fixed_height: {
				url: "http://media3.giphy.com/media/wWAIKcFASEFz2/200.gif",
				width: "358",
				height: "200",
				size: "126220",
				mp4: "http://media2.giphy.com/media/wWAIKcFASEFz2/200.mp4",
				mp4_size: "10967",
				webp: "http://media2.giphy.com/media/wWAIKcFASEFz2/200.webp",
				webp_size: "186460"
			},
			fixed_height_still: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/200_s.gif",
				width: "358",
				height: "200"
			},
			fixed_height_downsampled: {
				url: "http://media3.giphy.com/media/wWAIKcFASEFz2/200_d.gif",
				width: "358",
				height: "200",
				size: "352636",
				webp: "http://media2.giphy.com/media/wWAIKcFASEFz2/200_d.webp",
				webp_size: "159946"
			},
			fixed_width: {
				url: "http://media3.giphy.com/media/wWAIKcFASEFz2/200w.gif",
				width: "200",
				height: "112",
				size: "51889",
				mp4: "http://media2.giphy.com/media/wWAIKcFASEFz2/200w.mp4",
				mp4_size: "16299",
				webp: "http://media2.giphy.com/media/wWAIKcFASEFz2/200w.webp",
				webp_size: "70302"
			},
			fixed_width_still: {
				url: "http://media1.giphy.com/media/wWAIKcFASEFz2/200w_s.gif",
				width: "200",
				height: "112"
			},
			fixed_width_downsampled: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/200w_d.gif",
				width: "200",
				height: "112",
				size: "131311",
				webp: "http://media2.giphy.com/media/wWAIKcFASEFz2/200w_d.webp",
				webp_size: "60336"
			},
			fixed_height_small: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/100.gif",
				width: "179",
				height: "100",
				size: "126220",
				webp: "http://media2.giphy.com/media/wWAIKcFASEFz2/100.webp",
				webp_size: "56790"
			},
			fixed_height_small_still: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/100_s.gif",
				width: "179",
				height: "100"
			},
			fixed_width_small: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/100w.gif",
				width: "100",
				height: "56",
				size: "51889",
				webp: "http://media2.giphy.com/media/wWAIKcFASEFz2/100w.webp",
				webp_size: "21266"
			},
			fixed_width_small_still: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/100w_s.gif",
				width: "100",
				height: "56"
			},
			downsized: {
				url: "http://media0.giphy.com/media/wWAIKcFASEFz2/giphy.gif",
				width: "500",
				height: "279",
				size: "508488"
			},
			downsized_still: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/giphy_s.gif",
				width: "500",
				height: "279"
			},
			downsized_large: {
				url: "http://media0.giphy.com/media/wWAIKcFASEFz2/giphy.gif",
				width: "500",
				height: "279",
				size: "508488"
			},
			original: {
				url: "http://media0.giphy.com/media/wWAIKcFASEFz2/giphy.gif",
				width: "500",
				height: "279",
				size: "508488",
				frames: "7",
				mp4: "http://media2.giphy.com/media/wWAIKcFASEFz2/giphy.mp4",
				mp4_size: "45225",
				webp: "http://media2.giphy.com/media/wWAIKcFASEFz2/giphy.webp",
				webp_size: "305416"
			},
			original_still: {
				url: "http://media2.giphy.com/media/wWAIKcFASEFz2/giphy_s.gif",
				width: "500",
				height: "279"
			}
		}        
	},
    "meta": {
        "status": 200,
        "msg": "OK"
    }
}

Random 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/random?api_key=dc6zaTOxFJmzC&tag=american+psycho

Example random query

Path
/v1/gifs/random
Parameters
  • tag - the GIF tag to limit randomness by
  • rating - limit results to those rated (y,g, pg, pg-13 or r).
  • fmt - (optional) return results in html or json format (useful for viewing responses as GIFs to debug/test)

Sample Response, Random

{
    "data": {
		type: "gif",
		id: "Ggjwvmqktuvf2",
		url: "http://giphy.com/gifs/american-psycho-christian-bale-Ggjwvmqktuvf2",
		image_original_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.gif",
		image_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.gif",
		image_mp4_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.mp4",
		image_frames: "11",
		image_width: "500",
		image_height: "256",
		fixed_height_downsampled_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/200_d.gif",
		fixed_height_downsampled_width: "391",
		fixed_height_downsampled_height: "200",
		fixed_width_downsampled_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/200w_d.gif",
		fixed_width_downsampled_width: "200",
		fixed_width_downsampled_height: "102",
		fixed_height_small_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100.gif",
		fixed_height_small_still_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100_s.gif",
		fixed_height_small_width: "195",
		fixed_height_small_height: "100",
		fixed_width_small_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100w.gif",
		fixed_width_small_still_url: "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100w_s.gif",
		fixed_width_small_width: "100",
		fixed_width_small_height: "51"                 
    },
    "meta": {
        "status": 200,
        "msg": "OK"
    }
}

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": {
        type: "gif",
		id: "feqkVgjJpYtjy",
	    slug: "eyes-shocked-bird-feqkVgjJpYtjy",
		url: "http://giphy.com/gifs/eyes-shocked-bird-feqkVgjJpYtjy",
		bitly_gif_url: "http://gph.is/XJ200y",
		bitly_url: "http://gph.is/XJ200y",
		embed_url: "http://giphy.com/embed/feqkVgjJpYtjy",
		username: "",
		source: "http://littleanimalgifs.tumblr.com/post/17994517807",
		rating: "g",
		caption: "",
		content_url: "",
		source_tld: "littleanimalgifs.tumblr.com",
		source_post_url: "http://littleanimalgifs.tumblr.com/post/17994517807",
		import_datetime: "2013-03-21 04:03:08",
		trending_datetime: "2014-11-12 06:22:52",
		images: {
			fixed_height: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200.gif",
				width: "445",
				height: "200",
				size: "445432",
				mp4: "http://media0.giphy.com/media/feqkVgjJpYtjy/200.mp4",
				mp4_size: "27279",
				webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200.webp",
				webp_size: "420734"
			},
			fixed_height_still: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200_s.gif",
				width: "445",
				height: "200"
			},
			fixed_height_downsampled: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200_d.gif",
				width: "445",
				height: "200",
				size: "183225",
				webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200_d.webp",
				webp_size: "89516"
			},
			fixed_width: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w.gif",
				width: "200",
				height: "90",
				size: "115885",
				mp4: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w.mp4",
				mp4_size: "31919",
				webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w.webp",
				webp_size: "122600"
			},
			fixed_width_still: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w_s.gif",
				width: "200",
				height: "90"
			},
			fixed_width_downsampled: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w_d.gif",
				width: "200",
				height: "90",
				size: "83007",
				webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w_d.webp",
				webp_size: "26460"
			},
			fixed_height_small: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100.gif",
				width: "223",
				height: "100",
				size: "445432",
				webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/100.webp",
				webp_size: "129604"
			},
			fixed_height_small_still: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100_s.gif",
				width: "223",
				height: "100"
			},
			fixed_width_small: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100w.gif",
				width: "100",
				height: "45",
				size: "115885",
				webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/100w.webp",
				webp_size: "41620"
			},
			fixed_width_small_still: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100w_s.gif",
				width: "100",
				height: "45"
			},
			downsized: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.gif",
				width: "334",
				height: "150",
				size: "511581"
			},
			downsized_still: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy_s.gif",
				width: "334",
				height: "150"
			},
			downsized_large: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.gif",
				width: "334",
				height: "150",
				size: "511581"
			},
			original: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.gif",
				width: "334",
				height: "150",
				size: "511581",
				frames: "27",
				mp4: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.mp4",
				mp4_size: "97841",
				webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.webp",
				webp_size: "270108"
				},
				original_still: {
				url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy_s.gif",
				width: "334",
				height: "150"
			}
		}  
    },
    "meta": {
        "status": 200,
        "msg": "OK"
    }
}

Get GIFs by ID Endpoint

A multiget version of the get GIF by ID endpoint. In this case the IDs are feqkVgjJpYtjy and 7rzbxdu0ZEXLy. Note the additional user metadata attached to the document that describes the second GIF in the response, 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: [
    	{
			type: "gif",
			id: "feqkVgjJpYtjy",
	        slug: "eyes-shocked-bird-feqkVgjJpYtjy",
			url: "http://giphy.com/gifs/eyes-shocked-bird-feqkVgjJpYtjy",
			bitly_gif_url: "http://gph.is/XJ200y",
			bitly_url: "http://gph.is/XJ200y",
			embed_url: "http://giphy.com/embed/feqkVgjJpYtjy",
			username: "",
			source: "http://littleanimalgifs.tumblr.com/post/17994517807",
			rating: "g",
			caption: "",
			content_url: "",
			source_tld: "littleanimalgifs.tumblr.com",
			source_post_url: "http://littleanimalgifs.tumblr.com/post/17994517807",
			import_datetime: "2013-03-21 04:03:08",
			trending_datetime: "2014-11-12 06:22:52",
			images: {
				fixed_height: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200.gif",
					width: "445",
					height: "200",
					size: "445432",
					mp4: "http://media0.giphy.com/media/feqkVgjJpYtjy/200.mp4",
					mp4_size: "27279",
					webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200.webp",
					webp_size: "420734"
				},
				fixed_height_still: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200_s.gif",
					width: "445",
					height: "200"
				},
				fixed_height_downsampled: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200_d.gif",
					width: "445",
					height: "200",
					size: "183225",
					webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200_d.webp",
					webp_size: "89516"
				},
				fixed_width: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w.gif",
					width: "200",
					height: "90",
					size: "115885",
					mp4: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w.mp4",
					mp4_size: "31919",
					webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w.webp",
					webp_size: "122600"
				},
				fixed_width_still: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w_s.gif",
					width: "200",
					height: "90"
				},
				fixed_width_downsampled: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w_d.gif",
					width: "200",
					height: "90",
					size: "83007",
					webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/200w_d.webp",
					webp_size: "26460"
				},
				fixed_height_small: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100.gif",
					width: "223",
					height: "100",
					size: "445432",
					webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/100.webp",
					webp_size: "129604"
				},
				fixed_height_small_still: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100_s.gif",
					width: "223",
					height: "100"
				},
				fixed_width_small: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100w.gif",
					width: "100",
					height: "45",
					size: "115885",
					webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/100w.webp",
					webp_size: "41620"
				},
				fixed_width_small_still: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/100w_s.gif",
					width: "100",
					height: "45"
					},
				downsized: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.gif",
					width: "334",
					height: "150",
					size: "511581"
				},
				downsized_still: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy_s.gif",
					width: "334",
					height: "150"
				},
				downsized_large: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.gif",
					width: "334",
					height: "150",
					size: "511581"
				},
				original: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.gif",
					width: "334",
					height: "150",
					size: "511581",
					frames: "27",
					mp4: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.mp4",
					mp4_size: "97841",
					webp: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy.webp",
					webp_size: "270108"
				},
				original_still: {
					url: "http://media0.giphy.com/media/feqkVgjJpYtjy/giphy_s.gif",
					width: "334",
					height: "150"
				}
			}
		},
		{
			type: "gif",
			id: "7rzbxdu0ZEXLy",
	        slug: "mrdiv-art-mrdiv-disco-ball-7rzbxdu0ZEXLy",
			url: "http://giphy.com/gifs/mrdiv-art-mrdiv-disco-ball-7rzbxdu0ZEXLy",
			bitly_gif_url: "http://gph.is/13YkU2y",
			bitly_url: "http://gph.is/13YkU2y",
			embed_url: "http://giphy.com/embed/7rzbxdu0ZEXLy",
			username: "mrdiv",
			source: "http://mrdiv.tumblr.com/post/48618427039/disco-sphere",
			rating: "g",
			caption: "",
			content_url: "",
			user: {
		        avatar_url: "https://media3.giphy.com/avatars/mrdiv.gif",
		        banner_url: "",
		        profile_url: "https://giphy.com/mrdiv/",
		        username: "mrdiv",
		        display_name: "mr. div"
		      },
	      	source_tld: "mrdiv.tumblr.com",
	        source_post_url: "http://mrdiv.tumblr.com/post/48618427039/disco-sphere",
			import_datetime: "2013-06-18 11:30:02",
			trending_datetime: "1970-01-01 00:00:00",
			images: {
				fixed_height: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200.gif",
					width: "200",
					height: "200",
					size: "95494",
					mp4: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200.mp4",
					mp4_size: "17167",
					webp: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200.webp",
					webp_size: "71556"
				},
				fixed_height_still: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200_s.gif",
					width: "200",
					height: "200"
				},
				fixed_height_downsampled: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200_d.gif",
					width: "200",
					height: "200",
					size: "188423",
					webp: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200_d.webp",
					webp_size: "48112"
				},
				fixed_width: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200w.gif",
					width: "200",
					height: "200",
					size: "95494",
					mp4: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200w.mp4",
					mp4_size: "17167",
					webp: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200w.webp",
					webp_size: "71556"
				},
				fixed_width_still: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200w_s.gif",
					width: "200",
					height: "200"
				},
				fixed_width_downsampled: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200w_d.gif",
					width: "200",
					height: "200",
					size: "188423",
					webp: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/200w_d.webp",
					webp_size: "48112"
				},
				fixed_height_small: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/100.gif",
					width: "100",
					height: "100",
					size: "95494",
					webp: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/100.webp",
					webp_size: "25250"
				},
				fixed_height_small_still: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/100_s.gif",
					width: "100",
					height: "100"
				},
				fixed_width_small: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/100w.gif",
					width: "100",
					height: "100",
					size: "95494",
					webp: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/100w.webp",
					webp_size: "25250"
				},
				fixed_width_small_still: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/100w_s.gif",
					width: "100",
					height: "100"
				},
				downsized: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/giphy.gif",
					width: "500",
					height: "500",
					size: "1012692"
				},
				downsized_still: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/giphy_s.gif",
					width: "500",
					height: "500"
				},
				downsized_large: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/giphy.gif",
					width: "500",
					height: "500",
					size: "1012692"
				},
				original: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/giphy.gif",
					width: "500",
					height: "500",
					size: "1012692",
					frames: "9",
					mp4: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/giphy.mp4",
					mp4_size: "52678",
					webp: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/giphy.webp",
					webp_size: "262666"
				},
				original_still: {
					url: "http://media1.giphy.com/media/7rzbxdu0ZEXLy/giphy_s.gif",
					width: "500",
					height: "500"
				}
			}
		}
    ],
    "meta": {
        "msg": "OK",
        "status": 200
    },
    "pagination": {
        "count": 2,
        "offset": 0,
        "total_count": 2
    }
}

GIPHY STICKER API

The Giphy API that provide only animated stickers (aka animated GIFs with transparent backgrounds) in the responses. The available endpoints are as follows:

- Sticker Search
- Sticker Roulette (Random) 
- Sticker Trending
- Sticker Translate

STICKER API PUBLIC KEY : dc6zaTOxFJmzC

Note: the public key is subject to rate limit constraints. We do not encourage live production deployments to use the public key.

STICKER Search Endpoint

Replicates the functionality and requirements of the classic Giphy search, but returns animated stickers rather than gifs. Example cat

http://api.giphy.com/v1/stickers/search?q=cat&api_key=dc6zaTOxFJmzC
Path
/v1/stickers/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
  • rating - limit results to those rated (y,g, pg, pg-13 or r).
  • lang - (optional) specify default country for regional content; format is 2-letter ISO 639-1 country code. See list of supported langauges here
  • fmt - (optional) return results in html or json format (useful for viewing responses as GIFs to debug/test)

Sample Response: Search

{
    "data": [
        {
            "type": "gif",
            "id": "sj0sbNi9cv2dG",
            "slug": "cat-transparent-sj0sbNi9cv2dG",
            "url": "http://giphy.com/gifs/cat-transparent-sj0sbNi9cv2dG",
            "bitly_gif_url": "http://gph.is/Kq60z1",
            "bitly_url": "http://gph.is/Kq60z1",
            "embed_url": "http://giphy.com/embed/sj0sbNi9cv2dG",
            "username": "",
            "source": "http://ibehhvinny.tumblr.com/post/71539185754/so-coot",
            "rating": "g",
            "caption": "",
            "content_url": "",
            "source_tld": "www.tumblr.com",
  			"source_post_url": "http://www.tumblr.com",
            "import_datetime": "2014-01-04 15:39:18",
            "trending_datetime": "1970-01-01 00:00:00",
            "images": {
                "fixed_height": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/200.gif",
                    "width": "193",
                    "height": "200",
                    "mp4": "http://media.giphy.com/media/sj0sbNi9cv2dG/200.mp4"
                },
                "fixed_height_still": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/200_s.gif",
                    "width": "193",
                    "height": "200"
                },
                "fixed_height_downsampled": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/200_d.gif",
                    "width": "193",
                    "height": "200"
                },
                "fixed_width": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/200w.gif",
                    "width": "200",
                    "height": "207",
                    "mp4": "http://media.giphy.com/media/sj0sbNi9cv2dG/200w.mp4"
                },
                "fixed_width_still": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/200w_s.gif",
                    "width": "200",
                    "height": "207"
                },
                "fixed_width_downsampled": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/200w_d.gif",
                    "width": "200",
                    "height": "207"
                },
                "downsized": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/giphy.gif",
                    "width": "400",
                    "height": "414",
                    "size": "422870"
                },
                "downsized_still": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/giphy_s.gif",
                    "width": "400",
                    "height": "414"
                },
                "original": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/giphy.gif",
                    "width": "400",
                    "height": "414",
                    "size": "422870",
                    "frames": "39",
                    "mp4": "http://media.giphy.com/media/sj0sbNi9cv2dG/giphy.mp4"
                },
                "original_still": {
                    "url": "http://media2.giphy.com/media/sj0sbNi9cv2dG/giphy_s.gif",
                    "width": "400",
                    "height": "414"
                }
            }
        },
        ... 24 more items
    ],
    "meta": {
        "status": 200,
        "msg": "OK"
    },
    "pagination": {
        "total_count": 573,
        "count": 25,
        "offset": 0
    }
}

STICKER Trending Endpoint

Get the latest stickers trending on Giphy with this endpoint. Hand curated by the Giphy editorial team and refreshed daily.

http://api.giphy.com/v1/stickers/trending?api_key=dc6zaTOxFJmzC

Example trending query with html formatted response.

Example trending query with default json response.

Path
/v1/stickers/trending
Parameters
  • limit - (optional) number of results to return, maximum 100. Default: 25
  • offset - (optional) results offset, defaults to 0);
  • fmt - (optional) return results in html or json format (useful for viewing responses as GIFs to debug/test)
  • rating - limit results to those rated (y,g, pg, pg-13 or r).

Sample Response: Trending Stickers

{
    data: [
        {
        	type: "gif",
			id: "sj0sbNi9cv2dG",
			slug: "cat-transparent-sj0sbNi9cv2dG",
			url: "http://giphy.com/gifs/cat-transparent-sj0sbNi9cv2dG",
			bitly_gif_url: "http://gph.is/Kq60z1",
			bitly_url: "http://gph.is/Kq60z1",
			embed_url: "http://giphy.com/embed/sj0sbNi9cv2dG",
			username: "",
			source: "http://ibehhvinny.tumblr.com/post/71539185754/so-coot",
			rating: "g",
			caption: "",
			content_url: "",
	      	source_tld: "ibehhvinny.tumblr.com",
  			source_post_url: "http://ibehhvinny.tumblr.com/post/71539185754/so-coot",
			import_datetime: "2014-01-04 15:39:18",
			trending_datetime: "1970-01-01 00:00:00",
			images: {
				fixed_height: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200.gif",
					width: "193",
					height: "200",
					size: "136213",
					mp4: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200.mp4",
					mp4_size: "156945",
					webp: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200.webp",
					webp_size: "142110"
				},
				fixed_height_still: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200_s.gif",
					width: "193",
					height: "200"
				},
				fixed_height_downsampled: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200_d.gif",
					width: "193",
					height: "200",
					size: "45291",
					webp: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200_d.webp",
					webp_size: "21510"
				},
				fixed_width: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200w.gif",
					width: "200",
					height: "207",
					size: "140056",
					mp4: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200w.mp4",
					mp4_size: "157163",
					webp: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200w.webp",
					webp_size: "147254"
				},
				fixed_width_still: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200w_s.gif",
					width: "200",
					height: "207"
				},
				fixed_width_downsampled: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200w_d.gif",
					width: "200",
					height: "207",
					size: "46481",
					webp: "http://media0.giphy.com/media/sj0sbNi9cv2dG/200w_d.webp",
					webp_size: "22310"
				},
				fixed_height_small: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/100.gif",
					width: "97",
					height: "100",
					size: "136213",
					webp: "http://media0.giphy.com/media/sj0sbNi9cv2dG/100.webp",
					webp_size: "60522"
				},
				fixed_height_small_still: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/100_s.gif",
					width: "97",
					height: "100"
				},
				fixed_width_small: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/100w.gif",
					width: "100",
					height: "104",
					size: "140056",
					webp: "http://media0.giphy.com/media/sj0sbNi9cv2dG/100w.webp",
					webp_size: "63260"
				},
				fixed_width_small_still: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/100w_s.gif",
					width: "100",
					height: "104"
				},
				downsized: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/giphy.gif",
					width: "400",
					height: "414",
					size: "422870"
				},
				downsized_still: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/giphy_s.gif",
					width: "400",
					height: "414"
				},
				downsized_large: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/giphy.gif",
					width: "400",
					height: "414",
					size: "422870"
				},
				original: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/giphy.gif",
					width: "400",
					height: "414",
					size: "422870",
					frames: "39",
					mp4: "http://media0.giphy.com/media/sj0sbNi9cv2dG/giphy.mp4",
					mp4_size: "292473",
					webp: "http://media0.giphy.com/media/sj0sbNi9cv2dG/giphy.webp",
					webp_size: "289928"
				},
				original_still: {
					url: "http://media0.giphy.com/media/sj0sbNi9cv2dG/giphy_s.gif",
					width: "400",
					height: "414"
				}
			}                
    	},      
        ... 24 more items
    ],
    pagination: {
        count: 25,
        offset: 0
    },
    meta: {
        status: 200,
        msg: "OK"
    }
}

STICKER Translate Endpoint

Using the same alogirithm as the GIF translate endpoint, the sticker translate endpoint turns words into stickers.

http://api.giphy.com/v1/stickers/translate?s=hungry&api_key=dc6zaTOxFJmzC

Example translate query.

Path
/v1/stickers/translate
Parameters
  • s - term or phrase to translate into a gif
  • rating - limit results to those rated (y,g, pg, pg-13 or r).
  • lang - (optional) specify default country for regional content; format is 2-letter ISO 639-1 country code. See list of supported langauges here
  • fmt - (optional) return results in html or json format (useful for viewing responses as GIFs to debug/test)

Sample Response, Translate

{
    "data": {
        type: "gif",
		id: "11eZCNibwDFx6w",
		slug: "11eZCNibwDFx6w",
		url: "http://giphy.com/gifs/11eZCNibwDFx6w",
		bitly_gif_url: "http://gph.is/1ptYDDI",
		bitly_url: "http://gph.is/1ptYDDI",
		embed_url: "http://giphy.com/embed/11eZCNibwDFx6w",
		username: "",
		source: "http://www.gifbay.com/gif/here_take_this-123255/",
		rating: "g",
		caption: "",
		content_url: "",
		source_tld: "gifbay.com",
		source_post_url: "http://www.gifbay.com/gif/here_take_this-123255/",
		import_datetime: "2014-03-25 00:52:20",
		trending_datetime: "2015-01-08 16:09:46",
		images: {
			fixed_height: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/200.gif",
				width: "295",
				height: "200",
				size: "118405",
				mp4: "http://media1.giphy.com/media/11eZCNibwDFx6w/200.mp4",
				mp4_size: "265838",
				webp: "http://media1.giphy.com/media/11eZCNibwDFx6w/200.webp",
				webp_size: "219116"
			},
			fixed_height_still: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/200_s.gif",
				width: "295",
				height: "200"
			},
			fixed_height_downsampled: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/200_d.gif",
				width: "295",
				height: "200",
				size: "63883",
				webp: "http://media1.giphy.com/media/11eZCNibwDFx6w/200_d.webp",
				webp_size: "33256"
			},
			fixed_width: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/200w.gif",
				width: "200",
				height: "135",
				size: "72894",
				mp4: "http://media1.giphy.com/media/11eZCNibwDFx6w/200w.mp4",
				mp4_size: "175118",
				webp: "http://media1.giphy.com/media/11eZCNibwDFx6w/200w.webp",
				webp_size: "115364"
			},
			fixed_width_still: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/200w_s.gif",
				width: "200",
				height: "135"
			},
			fixed_width_downsampled: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/200w_d.gif",
				width: "200",
				height: "135",
				size: "29898",
				webp: "http://media1.giphy.com/media/11eZCNibwDFx6w/200w_d.webp",
				webp_size: "17654"
			},
			fixed_height_small: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/100.gif",
				width: "148",
				height: "100",
				size: "118405",
				webp: "http://media1.giphy.com/media/11eZCNibwDFx6w/100.webp",
				webp_size: "67436"
			},
			fixed_height_small_still: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/100_s.gif",
				width: "148",
				height: "100"
			},
			fixed_width_small: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/100w.gif",
				width: "100",
				height: "68",
				size: "72894",
				webp: "http://media1.giphy.com/media/11eZCNibwDFx6w/100w.webp",
				webp_size: "40942"
			},
			fixed_width_small_still: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/100w_s.gif",
				width: "100",
				height: "68"
			},
			downsized: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/giphy.gif",
				width: "294",
				height: "199",
				size: "375114"
			},
			downsized_still: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/giphy_s.gif",
				width: "294",
				height: "199"
			},
			downsized_large: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/giphy.gif",
				width: "294",
				height: "199",
				size: "375114"
			},
			original: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/giphy.gif",
				width: "294",
				height: "199",
				size: "375114",
				frames: "39",
				mp4: "http://media1.giphy.com/media/11eZCNibwDFx6w/giphy.mp4",
				mp4_size: "321196",
				webp: "http://media1.giphy.com/media/11eZCNibwDFx6w/giphy.webp",
				webp_size: "203110"
			},
			original_still: {
				url: "http://media1.giphy.com/media/11eZCNibwDFx6w/giphy_s.gif",
				width: "294",
				height: "199"
			}
    },
    "meta": {
        "status": 200,
        "msg": "OK"
    }
}

STICKER Roulette (Random) Endpoint

Returns a spotaneously selected sticker from Giphy's sticker collection. Optionally limit scope of result to a specific tag. Like the GIF random endpoint, Punctuation will be stripped and ignored. Use a hyphen for phrases. Example oops, birthday or thank-you. Search terms should be URL encoded.

http://api.giphy.com/v1/stickers/random?api_key=dc6zaTOxFJmzC&tag=oops

Example random query.

Path
/v1/stickers/random
Parameters
  • tag - search query term or phrase
  • rating - limit results to those rated (y,g, pg, pg-13 or r).
  • fmt - (optional) return results in 'html' or 'json' format (useful for viewing responses as GIFs to debug/test)
Sample Reponse: Random
{
    "data": {
       type: "gif",
		id: "XMfznXqrNvH2w",
		url: "http://giphy.com/gifs/animatedtext-transparent-lol-XMfznXqrNvH2w",
		image_original_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/giphy.gif",
		image_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/giphy.gif",
		image_mp4_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/giphy.mp4",
		image_frames: "30",
		image_width: "629",
		image_height: "154",
		fixed_height_downsampled_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/200_d.gif",
		fixed_height_downsampled_width: "817",
		fixed_height_downsampled_height: "200",
		fixed_width_downsampled_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/200w_d.gif",
		fixed_width_downsampled_width: "200",
		fixed_width_downsampled_height: "49",
		fixed_height_small_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/100.gif",
		fixed_height_small_still_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/100_s.gif",
		fixed_height_small_width: "408",
		fixed_height_small_height: "100",
		fixed_width_small_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/100w.gif",
		fixed_width_small_still_url: "http://s3.amazonaws.com/giphygifs/media/XMfznXqrNvH2w/100w_s.gif",
		fixed_width_small_width: "100",
		fixed_width_small_height: "24"
	},   
    "meta": {
        "status": 200,
        "msg": "OK"
    }
}

Once you are ready to use the Giphy STICKER API in production, please visit api.giphy.com/submit to request a unique API key. As per our section 5 A of our terms of service, we require all apps that use the Giphy API to conspicuously display "Powered By Giphy" attribution marks where the API is utilized. You can find approved official logo marks here.

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) 
puts 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"

Rendition Guide

  • fixed_height - Height set to 200px. Good for mobile use.
  • fixed_height_still - Static preview image for fixed_height
  • fixed_height_downsampled - Height set to 200px. Reduced to 6 frames to minimize file size to the lowest. Works well for unlimited scroll on mobile and as animated previews. See Giphy.com on mobile web as an example.
  • fixed_width - Width set to 200px. Good for mobile use.
  • fixed_width_still - Static preview image for fixed_width
  • fixed_width_downsampled - Width set to 200px. Reduced to 6 frames. Works well for unlimited scroll on mobile and as animated previews.
  • fixed_height_small - Height set to 100px. Good for mobile keyboards.
  • fixed_height_small_still - Static preview image for fixed_height_small
  • fixed_width_small - Width set to 100px. Good for mobile keyboards
  • fixed_width_small_still - Static preview image for fixed_width_small
  • preview - File size under 50kb. Duration may be truncated to meet file size requirements. Good for thumbnails and previews.
  • downsized_small - File size under 200kb.
  • downsized - File size under 2mb.
  • downsized_medium - File size under 5mb.
  • downsized_large - File size under 8mb.
  • downsized_still - Static preview image for downsized
  • original - Original file size and file dimensions. Good for desktop use.
  • original_still - Preview image for original
  • looping - Duration set to loop for 15 seconds. Only recommended for this exact use case.

Language Support

The GIPHY API offers language support across the Search and Translate APIs.

http://api.giphy.com/v1/gifs/search?q=amor&api_key=dc6zaTOxFJmzC&lang=es

Example search query.

Parameter
  • lang - specify default country for regional content; format is 2-letter ISO 639-1 country code

Supported Languages

  • Spanish (es)
  • Portuguese (pt)
  • Indonesian (id)
  • French (fr)
  • Arabic (ar)
  • Turkish (tr)
  • Thai (th)
  • Vietnamese (vi)
  • German (de)
  • Italian (it)
  • Japanese (ja)
  • Chinese Simplified (zh-CN
  • Chinese Traditional (zh-TW)
  • Russian (ru)
  • Korean (ko)
  • Polish (pl)
  • Dutch (nl)
  • Romanian (ro)
  • Hungarian (hu)
  • Swedish (sv)
  • Czech (cs)
  • Hindi (hi)
  • Bengali - bn
  • Danish - da
  • Farsi - fa
  • Filipino - tl
  • Finnish - fi
  • Hebrew - iw
  • Malay - ms
  • Norwegian - no
  • Ukrainian - uk

Upload API

Public Beta Key

The Giphy Upload API is open to the public. The same public beta key can be used to test out the endpoint.

  • The public beta key is "dc6zaTOxFJmzC”

Please note that the beta key will only allow you to upload content and retrieve the hosted Giphy GIF ID in the response. If you wish to upload directly to your existing or new Giphy Channel (example: giphy.com/channel/test), please see details below in Request an Upload Production Key. Please use this beta key while you develop your application and experiment with your integrations. The public key is subject to rate limit constraints and we do not encourage live production deployments to use the public key.

Request an Upload Production Key

Production Upload keys require a Giphy Channel Username to upload, host, and post content to. You can create a Giphy Channel by visiting Giphy.com/join. If you already have an existing Channel, you can use the same one if you desire.

Once your Channel is created, please include the Channel username (example: For giphy.com/community/test, your username is test) in your submission using the same Giphy API submission form. You will be prompted to submit your Giphy Channel username once you select "Upload" as your type of application. Please be prepared to provide all the following information detailed in the submission form.

Please note that production keys are currently limited to 1000 uploads per day. If you need to extend that, please send us a note in the submission form.

Overview

The Giphy Upload API allows you to upload and host your content programmatically to Giphy.com. We accept animated gifs or video files up to 100MB. Hosted Giphy URLs are supported and play on every major social network.

The following documentation describes how to upload animated GIFs or videos to Giphy.com using the API. If you're using the beta key, you will not need to include a Giphy channel username to your request. Only approved apps will need to include a Giphy channel username. You can use the endpoint to upload your content, attach tags and other meta tag in a single HTTP or HTTPS POST request.

Upload Endpoint

######path Host: upload.giphy.com URI: /v1/gifs Type: POST

######parameters

  • api_key : your private API key (string, required)
  • username : your assigned username (string, required for approved apps only)
  • file : the animated GIF or video file (local file resource, required if no source_image_url supplied)
  • source_image_url : the URL for the image or video you wish to upload (string, required if no file parameter specified)
  • tags : comma delimited list of tags (string, optional)
  • source_post_url : the source of the asset (string, optional)
  • is_hidden : true (boolean, optional)

The only three fields that are required are api_key, username and the file OR source_image_url. If both file & source_image_url form fields are supplied in the request, the file parameter will be used over the source_image_url. The is_hidden parameter allows you to mark your uploaded content as private (only visible on giphy.com if logged in as the associated user)

Upload Code Examples

cURL example upload using a file parameter:
curl -v -F "username=yourusername" -F "file=@/Some/path/to/giphy.gif"  -F "api_key=YOUR_API_KEY" -F "tags=tag1,tag2,tag3" -F "source_post_url=http://your.source-url.tld" "http://upload.giphy.com/v1/gifs"
cURL example upload using a source_image_url as a source:
curl -v -F "username=yourusername" -F "source_image_url=http://domain.com/public/path/to/giphy.gif"  -F "api_key=YOUR_API_KEY" -F "tags=tag1,tag2,tag3" -F "source_post_url=http://your.source-url.tld" "http://upload.giphy.com/v1/gifs"
JavaScript example
$.ajax({
    type: 'POST',
    url: 'http://upload.giphy.com/v1/gifs',
    data: {
        username: YOUR_USERNAME,
        api_key: YOUR_KEY,
        file: YOUR_FILE,
        source_image_url: YOUR_SOURCE_URL,
        tags: YOUR_TAGS
    },
    success: YOUR_SUCCESS_HANDLER,
    error: YOUR_ERROR_HANDLER
});

Upload request response format

Successful upload requests will result in a JSON response with a 200 status code:

{"data":{"id":"your_new_gif_id"},"meta":{"status":200,"msg":"OK"}}

Failed responses return a JSON response with a 400 error code):

{"meta":{"status":403,"msg":"Forbidden"}}  // bad API KEY

{"meta":{"status":403,"msg":"Bad Request - Error creating GIF"}} // attempting to upload a file that's not a valid animated GIF

Sharing and Promoting your Giphy API Project

Projects that leverage the Giphy API can be submitted to Giphy labs. Learn more about Giphy labs.

giphyapi's People

Contributors

dfinkler avatar namslam avatar gtzilla avatar alexchung avatar kkovach avatar drksephy avatar neanias avatar

Watchers

James Cloos avatar Rado Raykov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.