Ready to bring the engaging power of GIFs to your app through GIPHY?
By integrating with GIPHY, the first and largest GIF search engine, you gain free access to our ever-growing content library of GIFs and Stickers — featuring the latest in entertainment, sports, and breaking news from GIPHY's official content partners.
All of our content is searchable in over thirty languages and is available in various sizes so you get the highest quality images at the lowest file sizes. Plus, there's all the classic reaction GIFs you'll ever need.
Welcome to GIPHY API, where you can seamlessly integrate your app with the largest GIF and Sticker library in the world.
GIPHY API is simple and fast to use, but if you're looking for something with automatic updates and access to exclusive features, our SDK might be an even better fit for you — check out GIPHY SDK!
The following guide will walk you through the minimum viable GIPHY API integration for a seamless GIPHY experience in your app. If you have any questions, email us at developers@giphy.com.
The GIPHY experience is brought to life with two essential endpoints: Trending and Search.
The Trending endpoint automatically populates the most relevant and engaging content each and every day, while the Search endpoint lets users search our library of millions of GIFs and Stickers by entering a word or phrase.
All API calls need to be URL encoded.
GIPHY uses GIPHY Analytics to improve search results for your users. By calling our Action Register Endpoint each time a user views, clicks, or sends a GIF or Sticker, we will be able to customize our responses to your user's behavior. We highly recommend calling this endpoint on every user action in your app.
To add analytics to your app, head to our Action Register Endpoint.
We require all apps that use GIPHY API to conspicuously display "Powered By GIPHY" attribution marks where the API is utilized (see SDK attribution guide here). You can find approved official logo marks here.
Before getting started with GIPHY API, please take a look at our API Terms of Service.. If you currently are using GIPHY API, then the API Terms of Service apply.
If you want to see these endpoints in action before getting started, you can use our API Explorer to input sample queries and view the live responses!
GIPHY Trending returns a list of the most relevant and engaging content each and every day. Our feed of trending content is continuously updated, so you always have the latest and greatest at your fingertips.
Gif URL | Sticker URL |
---|---|
api.giphy.com/v1/gifs/trending | api.giphy.com/v1/stickers/trending |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
limit: integer (int32) | 20 | The maximum number of objects to return. (Default: “25”) |
offset: integer (int32) | 5 | Specifies the starting position of the results. Default: “0” Maximum: “499” |
rating: string | g | Filters results by specified rating. Acceptable values include g, pg, pg-13, r. If you do not specify a rating, you will receive results from all possible ratings. |
random_id: string | e826c9fc5c929e0d6c6d423841a282aa | An ID/proxy for a specific user. |
bundle: string | messaging_non_clips | Returns only renditions that correspond to the named bundle. Read more about renditions. |
GIPHY Search gives you instant access to our library of millions of GIFs and Stickers by entering a word or phrase. With our unparalleled search algorithm, users can easily express themselves and animate their conversations.
Gif URL | Sticker URL |
---|---|
api.giphy.com/v1/gifs/search | api.giphy.com/v1/stickers/search |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
q: string(required) | cheeseburgers | Search query term or phrase. Adding @<username> anywhere in the q parameter effectively changes the search query to be a search for a specific user’s GIFs (user has to be public and verified user by GIPHY.) If the q parameter contains one of these words: sticker, stickers, or transparent, the search will return stickers content. Maximum length: 50 chars. |
limit: integer (int32) | 20 | The maximum number of objects to return. (Default: “25”).For beta keys max limit is 50 |
offset: integer (int32) | 5 | Specifies the starting position of the results. Default: “0” Maximum: “4999” |
rating: string | g | Filters results by specified rating. Acceptable values include g, pg, pg-13, r. If you do not specify a rating, you will receive results from all possible ratings. |
lang: string | en | Specify default language for regional content; use a 2-letter ISO 639-1 language code. |
random_id: string | e826c9fc5c929e0d6c6d423841a282aa | An ID/proxy for a specific user. |
bundle: string | messaging_non_clips | Returns only renditions that correspond to the named bundle. Read more about renditions. |
GIPHY Translate converts words and phrases to the perfect GIF or Sticker using GIPHY's special sauce algorithm. This feature is best exhibited in GIPHY's Slack integration.
Gif URL | Sticker URL |
---|---|
api.giphy.com/v1/gifs/translate | api.giphy.com/v1/stickers/translate |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
s: string(required) | "ryan gosling" or "ryan @gosling #cat" | Recommends a single gif. In order to pull such result supply query param "s" with desired term. It's possible to use @ or # to help search user channel(@) or gif's related to hashtag word |
rating: string | g | Filters results by specified rating. Acceptable values include g, pg, pg-13, r. If you do not specify a rating, you will receive results from all possible ratings. |
random_id: string | e826c9fc5c929e0d6c6d423841a282aa | An ID/proxy for a specific user. |
GIPHY Random lets you add some weirdness to the conversation by returning a single random GIF or Sticker related to the word or phrase entered. If no tag is specified, the GIF or Sticker returned is completely random.
Gif URL | Sticker URL |
---|---|
api.giphy.com/v1/gifs/random | api.giphy.com/v1/stickers/random |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
tag: string | "burrito" or "burrito @cat" | Filters results by specified tag. Retrieves any random gif. You can optimize results by supplying gif tag @username rating query parameters. |
rating: string | g | Filters results by specified rating. If you do not specify a rating, you will receive results from all possible ratings. |
random_id: string | e826c9fc5c929e0d6c6d423841a282aa | An ID/proxy for a specific user. |
GIPHY’s Action Register registers each time a user views, clicks, or sends a GIF or Sticker and plays an important role in helping GIPHY improve your user’s search results.
On almost all of our endpoints we return an Analytics Object for each of the GIF in the response for most endpoints.
To register an action when user views/clicks/sends a GIF, you should make a request by hitting the corresponding URL in the Analytics Object as such, and append the required params in the URL.
Impression | Click | Send |
---|---|---|
GET analytics->onload->url | GET analytics->onclick->url | GET analytics->onsent->url |
We recommend getting a Random ID for each user by using the Random ID Endpoint. This will allow GIPHY’S API to adjust responses to your users without the use of personally identifiable information.
Request Parameters: | Example: | Description: |
---|---|---|
random_id: string(required) | e826c9fc5c929e0d6c6d423841a282aa | An ID/proxy for a specific user. |
ts: integer (int)(required) | 1527703430507 | A UNIX timestamp in milliseconds corresponding to when the action occurred. |
GIPHY Random ID Endpoint allows GIPHY to generate a unique ID you can assign to each new user in your app.
To get the most out of Random ID, we recommend sending the random_id param with all compatible endpoints. This lets us adjust the API response to your users’ preferences and improve their GIF experience while maintaining their privacy.
URL |
---|
api.giphy.com/v1/randomid |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
GIPHY has released a feature across all GIPHY apps and platforms that makes GIPHY’s uniquely diverse emoji library more accessible than ever. Pairing custom artwork with a purpose-built API endpoint, GIPHY emojis allow you to bring animated reaction emojis to your users with style and ease.
This endpoint is used to fetch GIF Objects for the set of GIPHY Emoji.
variation_count
URL |
---|
api.giphy.com/v2/emoji |
Request Parameters: | Example: | Description: |
---|---|---|
limit: integer (int32) | 20 | The maximum number of objects to return. (Default: 25) |
offset: integer (int32) | 5 | Specifies the starting position of the results. (Default: 0) |
If an emoji's' variation_count
is greater than 0, use the Emoji Variations Endpoint to fetch its variations.
Fetch the variations associated with a given emoji using the "id"
property of the The GIF Object.
URL |
---|
api.giphy.com/v2/emoji/{gif_id}/variations |
On the front-end, we reccomend displaying the variations in a tray above the emoji, as is a standard in popular platforms across mobile and web.
Check out the GIPHY Mobile Apps, or the GIPHY SDK, to see how we've chosen to display emoji variations.
Get GIF by ID returns a GIF’s metadata based on the GIF ID specified.
URL |
---|
api.giphy.com/v1/gifs/<gif_id> |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
gif_id: string(required) | xT4uQulxzV39haRFjG | The ID of the GIF you want details for. |
random_id: string | e826c9fc5c929e0d6c6d423841a282aa | An ID/proxy for a specific user. |
rating: string | g | If the GIF has a rating higher than the rating parameter, the API will return an empty response with a Meta Object containing a 4xx error code. |
Get GIFs by ID returns metadata of multiple GIFs based on the GIF IDs specified.
URL |
---|
api.giphy.com/v1/gifs |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
ids: string(required) | xT4uQulxzV39haRFjG, 3og0IPxMM0erATueVW | Filters results by specified GIF IDs, separated by commas. Maximum GIF IDs: “100” |
random_id: string | e826c9fc5c929e0d6c6d423841a282aa | An ID/proxy for a specific user. |
rating: string | g | Filters results by specified rating. Acceptable values include g, pg, pg-13, r. If you do not specify a rating, you will receive results from all possible ratings. |
GIPHY Upload allows you to upload your content programmatically on GIPHY.com. We accept animated GIFs or video files up to 100MB.
Note: If you're using a rate-limited key assigned by the developer portal, you will not be able to specify a GIPHY channel username to your request and you will be limited to 10 uploads per day. To have these limits removed, you can apply for a production key from your dashboard. Only approved apps will be able to include a GIPHY channel username. You can use this endpoint to upload your content, attach tags, and other meta tag in a single HTTP or HTTPS POST request.
URL |
---|
upload.giphy.com/v1/gifs |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
username: string | JoeCool3000 | Your assigned username (required for approved apps only). |
file: string(binary) | The animated GIF or video file you'd like to upload. (Local file resource, required if no source_image_url supplied). | |
source_image_url: string | http://www.mysite.com/myfile.mp4 | The URL for the image or video you wish to upload (required if no file parameter specified). |
tags: string | pets, cat, meow | A comma delimited list of tags to be applied to the upload. |
source_post_url: string | http://www.mysite.com/my-post/ | The URL of the source of the asset. |
Providers users a list of Gif categories on the GIPHY network.
URL |
---|
api.giphy.com/v1/gifs/categories |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
Providers users a list of valid terms that completes the given tag on the GIPHY network.
URL |
---|
api.giphy.com/v1/gifs/search/tags |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
q: string(required) | foo | Tag term. |
limit: integer (int32) | 20 | The maximum number of objects to return. (Default: 5) |
offset: integer (int32) | 5 | Specifies the starting position of the results. (Default: 0) |
Channel Search endpoint returns all the GIPHY channels matching the query term
URL |
---|
api.giphy.com/v1/channels/search |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
q: string(required) | foo | Accepts term to search through GIPHY’s channels |
limit: integer (int32) | 20 | The maximum number of objects to return. Default: “25” Maximum: “50” |
offset: integer (int32) | 5 | Specifies the starting position of the results. Default: “0” |
Providers users a list of tag terms related to the given tag on the GIPHY network.
URL |
---|
api.giphy.com/v1/tags/related/<term> |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
term: string(required) | haha | Tag term. |
Provides users a list of the most popular trending search terms on the GIPHY network.
URL |
---|
api.giphy.com/v1/trending/searches |
Request Parameters: | Example: | Description: |
---|---|---|
api_key: string(required) | YOUR_API_KEY | GIPHY API Key. |
GIF Objects are returned from most of GIPHY API's Endpoints. These objects contain a variety of information, such as the Image Object, which itself includes the URLS for multiple different GIFS formats and sizes.
Property: | Example |
---|---|
type: string(default:"gif") By default, this is almost always GIF. | "gif" |
id: string This GIF's unique ID | "YsTs5ltWtEhnq" |
slug: string The unique slug used in this GIF's URL | "confused-flying-YsTs5ltWtEhnq" |
url: string The unique URL for this GIF | "http://giphy.com/gifs/confused-flying-YsTs5ltWtEhnq" |
bitly_url: string The unique bit.ly URL for this GIF | "http://gph.is/1gsWDcL" |
embed_url: string A URL used for embedding this GIF | "http://giphy.com/embed/YsTs5ltWtEhnq" |
username: string The username this GIF is attached to, if applicable | "JoeCool4000" |
source: string The page on which this GIF was found | "http://www.reddit.com/r/reactiongifs/comments/1xpyaa/superman_goes_to_hollywood/" |
rating: string The MPAA-style rating for this content. Examples include Y, G, PG, PG-13 and R | "g" |
content_url: string Currently unused |
|
user: User An object containing data about the user associated with this GIF, if applicable. |
|
source_tld: string The top level domain of the source URL. | "cheezburger.com" |
source_post_url: string The URL of the webpage on which this GIF was found. | "http://cheezburger.com/5282328320" |
update_datetime: string The date on which this GIF was last updated. | "2013-08-01 12:41:48" |
create_datetime: string The date this GIF was added to the GIPHY database. | "2013-08-01 12:41:48" |
import_datetime: string The creation or upload date from this GIF's source. | "2013-08-01 12:41:48" |
trending_datetime: string The date on which this gif was marked trending, if applicable. | "2013-08-01 12:41:48" |
images: Images An object containing data for various available formats and sizes of this GIF. |
|
title: string The title that appears on giphy.com for this GIF. | "Happy Dancing GIF" |
alt_text: string Alt text enables assistive programs to read descriptions of GIFs. | "Barney the Purple Dinosaur blows out birthday candles." |
The Images Object found in the GIF Object contains a series of Rendition Objects. These Rendition Objects includes the URLs and sizes for the many different renditions we offer for each GIF. For more information and best practices on selecting the best image format for your needs, please see our Rendition Guide. (Please note that some GIFs don’t have every property available.)
Object | Property | Example |
---|---|---|
fixed_height: object Data on versions of this GIF with a fixed height of 200 pixels. Good for mobile use. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200.mp4" | |
mp4_size: string The size in bytes of the .MP4 file corresponding to this GIF. | "25123" | |
webp: string The URL for this GIF in .webp format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200.webp" | |
webp_size: string The size in bytes of the .webp file corresponding to this GIF. | "12321" | |
fixed_height_still: object Data on a static image of this GIF with a fixed height of 200 pixels. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200_s.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
fixed_height_downsampled: object Data on versions of this GIF with a fixed height of 200 pixels and the number of frames reduced to 6. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200_d.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
webp: string The URL for this GIF in .webp format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200_d.webp" | |
webp_size: string The size in bytes of the .webp file corresponding to this GIF. | "12321" | |
fixed_width: object Data on versions of this GIF with a fixed width of 200 pixels. Good for mobile use. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200w.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200w.mp4" | |
mp4_size: string The size in bytes of the .MP4 file corresponding to this GIF. | "25123" | |
webp: string The URL for this GIF in .webp format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200w.webp" | |
webp_size: string The size in bytes of the .webp file corresponding to this GIF. | "12321" | |
fixed_width_still: object Data on a static image of this GIF with a fixed width of 200 pixels. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200w_s.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
fixed_width_downsampled: object Data on versions of this GIF with a fixed width of 200 pixels and the number of frames reduced to 6. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200w_d.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
webp: string The URL for this GIF in .webp format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/200w_d.webp" | |
webp_size: string The size in bytes of the .webp file corresponding to this GIF. | "12321" | |
fixed_height_small: object Data on versions of this GIF with a fixed height of 100 pixels. Good for mobile keyboards. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "100" | |
size: string The size of this GIF in bytes. | "32381" | |
mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100.mp4" | |
mp4_size: string The size in bytes of the .MP4 file corresponding to this GIF. | "25123" | |
webp: string The URL for this GIF in .webp format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100.webp" | |
webp_size: string The size in bytes of the .webp file corresponding to this GIF. | "12321" | |
fixed_height_small_still: object Data on a static image of this GIF with a fixed height of 100 pixels. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100_s.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "100" | |
fixed_width_small: object Data on versions of this GIF with a fixed width of 100 pixels. Good for mobile keyboards. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100w.gif" |
width: string The width of this GIF in pixels. | "100" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100w.mp4" | |
mp4_size: string The size in bytes of the .MP4 file corresponding to this GIF. | "25123" | |
webp: string The URL for this GIF in .webp format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100w.webp" | |
webp_size: string The size in bytes of the .webp file corresponding to this GIF. | "12321" | |
fixed_width_small_still: object Data on a static image of this GIF with a fixed width of 100 pixels. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/100w_s.gif" |
width: string The width of this GIF in pixels. | "100" | |
height: string The height of this GIF in pixels. | "200" | |
downsized: object Data on a version of this GIF downsized to be under 2mb. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy-downsized.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
downsized_still: object Data on a static preview image of the downsized version of this GIF. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy-downsized_s.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
downsized_large: object Data on a version of this GIF downsized to be under 8mb. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy-downsized-large.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
downsized_medium: object Data on a version of this GIF downsized to be under 5mb. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy-downsized-medium.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
downsized_small: object Data on a version of this GIF downsized to be under 200kb. | mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/downsized_small.mp4" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
mp4_size: string The size in bytes of the .MP4 file corresponding to this GIF. | "25123" | |
original: object Data on the original version of this GIF. Good for desktop use. | width: string The width of this GIF in pixels. | "320" |
height: string The height of this GIF in pixels. | "200" | |
size: string The size of this GIF in bytes. | "32381" | |
frames: string The number of frames in this GIF. | "15" | |
mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy.mp4" | |
mp4_size: string The size in bytes of the .MP4 file corresponding to this GIF. | "25123" | |
webp: string The URL for this GIF in .webp format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy.webp" | |
webp_size: string The size in bytes of the .webp file corresponding to this GIF. | "12321" | |
original_still: object Data on a static preview image of the original GIF. | url: string The publicly-accessible direct URL for this GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy_s.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
looping: object Data on the 15 second version of the GIF looping. | mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/looping.mp4" |
preview: object Data on a version of this GIF in .MP4 format limited to 50kb that displays the first 1-2 seconds of the GIF. | mp4: string The URL for this GIF in .MP4 format. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy-preview.mp4" |
mp4_size: string The size in bytes of the .MP4 file corresponding to this GIF. | "25123" | |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" | |
preview_gif: object Data on a version of this GIF limited to 50kb that displays the first 1-2 seconds of the GIF. | url: string The URL for this preview GIF. | "https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy-preview.gif" |
width: string The width of this GIF in pixels. | "320" | |
height: string The height of this GIF in pixels. | "200" |
The Meta Object contains basic information regarding the response and its status. You can learn more about the different types of response codes the API might give you in the Response Codes section.
Property: | Example |
---|---|
msg: string HTTP Response Message. (required) | "OK" |
status: integer (int32) HTTP Response Code. (required) | 200 |
response_id: string A unique ID paired with this response from the API. | "57eea03c72381f86e05c35d2" |
The Pagination Object contains information relating to the number of total results available as well as the number of results fetched and their relative positions.
Property: | Example |
---|---|
offset: integer (int32) Position in pagination. | 2591 |
total_count: integer (int32) Total number of items available (not returned on every endpoint). | 250 |
count: integer (int32) Total number of items returned. | 25 |
The User Object contains information about the user associated with a GIF and URLs to assets such as that user's avatar image, GIPHY profile, and more.
Property: | Example |
---|---|
avatar_url: string The URL for this user's avatar image. | "https://media1.giphy.com/avatars/election2016/XwYrZi5H87o6.gif" |
banner_url: string The URL for the banner image that appears atop this user's profile page. | "https://media4.giphy.com/avatars/cheezburger/XkuejOhoGLE6.jpg" |
profile_url: string The URL for this user's GIPHY profile. | "https://giphy.com/cheezburger/" |
username: string The username associated with this user. | "joecool4000" |
display_name: string The display name associated with this user (contains formatting the base username might not). | "JoeCool4000" |
The Random ID Object contains a random hash.
Property: | Example |
---|---|
random_id: string Random ID hash. | "3640f6095c9a1f0f4e544b764d238b25" |
The GIF Object that also contains additional properties:
Property: | Example |
---|---|
variation_count: int The number of variations associated with the emoji returned from the v2/emoji endpoint | "4" |
Most of our endpoints return an Analytics Object. The Analytics Object provides URLs so you can register actions, such as when a user views, clicks, or sends a GIF. For detailed instructions, refer to the Action Register Endpoint.
Object | Property | Example |
---|---|---|
onload: object | url: string The URL to register a 'view' action by a user. | "URL" |
onclick: object | url: string The URL to register a 'click' action by a user. | "URL" |
onsent: object | url: string The URL to register a 'send' action by a user. | "URL" |
The category Object contains category data with links to Subcategory Object and featured Gif Object
Property: | Example |
---|---|
name: string Category name | "category 1" |
name_encoded: string Encoded category name | "category1" |
subcategories: Subcategory Object[] List of subcategories |
|
gif: Gif Object Featured gif for category. |
|
The sub category Object contains category data
Property: | Example |
---|---|
name: string Category name | "sub category 1" |
name_encoded: string Encoded category name | "sub category1" |
The term Object contains term value
Property: | Example |
---|---|
name: string Term name | "lol" |
The Channel Object contains channel data with references to the parent and children channels
Property: | Example |
---|---|
id: number Channel unique ID | 42 |
url: string Channel relative URL | "/giphystudios" |
display_name: string The display name of the channel | "GIPHY Studios" |
parent: number Parent Channel ID | 20 |
slug: string The unique channel slug. This slug is used in the channel URL | "giphystudios" |
type: string Possible values are community or editorial | "community" |
content_type: string Possible values are gif , sticker , channel_gif , or channel_sticker | "gif" |
user: User An object containing data about the user associated with this Channel |
|
banner_image: string Channel banner image URL | "https://media.giphy.com/headers/giphystudios/WWv21rRnktty.jpg" |
short_display_name: string The short display name of the channel | "GIPHY" |
description: string Channel description | "GIPHY Studios is making all the GIFs" |
metadata_description: string Channel metadata description | "Making all the GIFs" |
has_children: boolean Indicates that the channel has sub-channels | false |
is_visible: boolean Indicates that the channel is visible. Note: This property is deprecated. | true |
is_private: boolean Indicates the public visibility of the channel. A private channel can only be viewed by the owner. | true |
is_live: boolean Indicates that the channel is live Note: This property is deprecated. | false |
featured_gif: Gif An object containing data about the channel's featured gif |
|
screensaver_gif: string Channel screensaver GIF's ID | "4QEPRmyUtrWxKIkMq5" |
tags: Channel Tag[] List of channel tags | [] |
live_since_datetime: string | "2020-07-20T03:27:19+0000" |
live_until_datetime: string | "2020-07-21T03:27:19+0000" |
ancestors: Channel[] List of parent channels | [] |
syncable_tags: Channel Tag[] List of channel syncable tags | [] |
analytics_response_payload: string | "e=ZXZlbnRfdHlwZT1DSEFOTkVMX1NFQVJDSCZjaWQ9YTMxNzNj..." |
Tag associated with the channel
Property: | Example |
---|---|
id: number Tag unique ID | 267 |
channel: number The ID of the channel associated with the tag | 42 |
rank: number The rank of the tag | 1 |
tag: string The tag | "happy" |
GIPHY API returns a synthetic response when there are issues with GIPHY downstream systems. This API response object has a meta.status=200
, meta.response_id=""
and the rest of the API object is empty. This should be treated as an error state and handled accordingly in the application.
The API will return a Meta Object in its response containing one of the following codes to describe the result of your request.
Code | Type | Description |
---|---|---|
200 | OK | Your request was successful! |
400 | Bad Request | Your request was formatted incorrectly or missing a required parameter(s). |
401 | Unauthorized | Your request lacks valid authentication credentials for the target resource, which most likely indicates an issue with your API Key or the API Key is missing. |
403 | Forbidden | You weren't authorized to make your request; most likely this indicates an issue with your API Key. |
404 | Not Found | The particular GIF or Sticker you are requesting was not found. This occurs, for example, if you request a GIF by using an id that does not exist. |
414 | URI Too Long | The length of the search query exceeds 50 characters. |
429 | Too Many Requests | Your API Key is making too many requests. Read about requesting a Production Key to upgrade your API Key rate limits. |