Schema definitions

The GIF Object

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.

PropertyExample
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"

The Images Object

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.)

ObjectPropertyExample
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 for this size of the 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"
"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.
"12381"
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.
"12381"
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.
"12381"
downsized_small: object
Data on a version of this GIF downsized to be under 200kb.
url: string
The publicly-accessible direct URL for this GIF.
"https://media1.giphy.com/media/cZ7rmKfFYOvYI/downsized_small.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.
"12381"
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.
"12381"
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
he URL for this GIF in .MP4 format.
"https://media1.giphy.com/media/cZ7rmKfFYOvYI/giphy-preview.mp4"
mp4_size: string
The size of this file in bytes.
"20241"
width: string
The width of this file in pixels.
"320"
height: string
The height of this file 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

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.

PropertyExample
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

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.

PropertyExample
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

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.

PropertyExample
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

The Random ID Object contains a random hash.

PropertyExample
random_id: string
Random ID hash.
"3640f6095c9a1f0f4e544b764d238b25"

The Analytics Object

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.

PropertyExample
onload: objecturl: string
The URL to register a 'view' action by a user.
"URL"
onclick: objecturl: string
The URL to register a 'click' action by a user.
"URL"
onsent: objecturl: string
The URL to register a 'send' action by a user.
"URL"