The GifMe API and Developers Documentation
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md

README.md

GifMeApi

GifMe is an app that makes saving, sharing and organizing gifs easier. It is also home to one of the largest gif search engines. GifMe has an API that allows 3rd party developers to use the data and tap into the gifs and images collected by GifMe users.

Basics

The API is a read only api. You can query a number of endpoints and get data from those. Below is the documentation on how to use it. You can query these enpoints as basic GET requests.

API KEY

For the time being you are free to use the following key. Please note that any abuse of this key will result in a change of policy. We are working to setup a dev center where you can register to get a key for your app.

If you plan to use the API in a production application please email us hello@gifme.io and we can set you up with a specific key.

API KEY: rX7kbMzkGu7WJwvG

POWERED BY TAGS

There are a number of powered by tags that you can use.


http://gifme.io/powered_by_pink.png


http://gifme.io/powered_by.png


http://gifme.io/powered_by_white.png


http://gifme.io/powered_by_black_out.png

Search

The search API is powered by the same engine and alogrithm that powers the GifMe search engine. It accepts a query and will first find all tags that contain the query, then run an algorithm that scores the tags agains the query and produces a 'score'. The lower the score the more relavent the tag is to the query.

Endpoint: http://api.gifme.io/v1/search Arguments

  • query - The term you are searching for
  • limit - The number of results to serve up. Max 42
  • page - The page of results you want NOTE: Pages are 0 based
  • sfw - true or false, will filter NSFW Gifs
  • key - Your API key

Upon hitting the API you will get a response that looks similar to this:

{
    status: 200,
    meta: {
        term: "r/filmgifs",
        limit: 1,
        page: 0,
        total_pages: 52,
        total: 52,
        timing: "0.167ms"
    },
    data: [
        {
            id: 162445,
            score: 0,
            nsfw: false,
            link: "http://i.imgur.com/FkQ1Hfv.gif",
            thumb: "http://i.gifme.io/gifme/thumb__1e656c194f.gif",
            created_at: "2014-07-14T22:28:27.412Z",
            tags: [
                "fast",
                "times",
                "ridgemont",
                "high",
                "skull",
                "shoe",
                "weed",
                "smoke",
                "420",
                "pot",
                "bong",
                "phone",
                "loop",
                "cinemagraph",
                "r/filmgifs"
            ]
        }
    ]
}

This query was http://api.gifme.io/v1/search?query=r/filmgifs&limit=1&page=0&key=rX7kbMzkGu7WJwvG

From the results you will see the following:

  • Status: The server status
  • Meta
    • Term: The term you searched for.
    • limit: Number of results you requested.
    • page: Current page of results you requested.
    • total_pages: Total number of pages based on your limit.
    • total: Total number of results.
    • timing: Time it took to process in ms.
  • Data
    • id: Gif ID
    • score: The relevancy to your term ( 0 is best )
    • nsfw: If the result is NSFW
    • link: The original source
    • thumb: The static thumbnail
    • created_at: Creation date
    • Tags: The other tags associated with this Gif

NOTE: Pages are 0 based This means that page 0 is the first page.

Stream

The stream is a real time stream of Gifs and tags that are saved into GifMe.

Endpoint: http://api.gifme.io/v1/stream?key=rX7kbMzkGu7WJwvG

The results of this query will look something like this:

{
    status: 200,
    meta: {
        timing: "0.521ms"
    },
    data: [
        {
            id: 481585,
            created_at: "2014-07-20T03:54:10.844Z",
            thumb: "http://i.gifme.io/gifme/thumb__6b3c891d38.gif",
            link: "http://i.imgur.com/fB19z.gif",
            origin: 'http://i.imgur.com/fB19z.gif',
            nsfw: false,
            tags: [
                "over your head"
            ]
        },
        {
            id: 481584,
            created_at: "2014-07-20T03:53:48.245Z",
            thumb: "http://i.gifme.io/gifme/thumb__1c019b1953.gif",
            link: "https://31.media.tumblr.com/7ac1def41e60d8c1c75c9a1638a1a4ec/tumblr_n8vnk0tD4V1s95j2so5_250.gif",
            origin: "https://31.media.tumblr.com/7ac1def41e60d8c1c75c9a1638a1a4ec/tumblr_n8vnk0tD4V1s95j2so5_250.gif",
            nsfw: false,
            tags: [
                "but we arnt men"
            ]
        }
    ]
}

Similar to the search return. Note that the tags are returned as a string and not broken up.

  • Status: The server status
  • Meta
    • timing: Time it took to process in ms.
  • Data
    • id: Gif ID
    • nsfw: If the result is NSFW
    • link: The link to the gif / some are hosted at http://gifs.gime.io
    • origin: The original source
    • thumb: The static thumbnail
    • created_at: Creation date
    • Tags: The other tags associated with this Gif

Gif Detail

You can query for a specific Gif's details. For this you will need to provide the Gif ID as a part of the URL.

Endpoint: http://api.gifme.io/v1/gif/:ID?key=rX7kbMzkGu7WJwvG

The results of this query will look something like this:

{
    status: 200,
    meta: {
        timing: "0.020ms"
    },
    gif: {
        id: 470809,
        link: "http://24.media.tumblr.,com/e3487212d3cf1740d495c136fce94c63/tumblr_mksz40N8FC1qfrkf9o3_250.gif",
        origin: 'http://24.media.tumblr.,com/e3487212d3cf1740d495c136fce94c63/tumblr_mksz40N8FC1qfrkf9o3_250.gif'
        thumb: "http://i.gifme.io/gifme/thumb__5eff9a84cc.gif",
        nsfw: false,
        created_at: "2014-07-15T14:49:11.118Z",
        tags: [
            "neat",
            "archer"
        ]
    }
}

Trending Searches

Trending searches are the top rated searches that happen within a 24 hour period. It returns the top 50 searches.

Endpoint: http://api.gifme.io/v1/trending?key=rX7kbMzkGu7WJwvG

The results will look something like this.

{
    status: 200,
    trending: [
        {
            id: 1585,
            link: "https://gifme.io/search/q?query=gtfo",
            term: "gtfo",
            queries: 831,
            results: 224
        },
        {
            id: 241,
            link: "https://gifme.io/search/q?query=money",
            term: "money",
            queries: 819,
            results: 303
        },
        {
            id: 348,
            link: "https://gifme.io/search/q?query=smile",
            term: "smile",
            queries: 740,
            results: 752
        }
    ]
}

RANDOM

Will return 1 random image based on a tag, or if no tag is supplied it will just return a random Gif.

NOTE: All results returned from this endpoint are SFW.

Endpoint: http://api.gifme.io/v1/gifs/random?term=happy&key=rX7kbMzkGu7WJwvG

The results will look something like this.

{
    status: 200,
    meta: {
        term: "happy",
        timing: "0.030ms"
    },
    gif: {
        id: 72437,
        gif: "http://media.tumblr.com/691e21f0ea8bfdaef1dc02aba8d0aced/tumblr_inline_msb3m0Xeu91qz4rgp.gif",
        thumb: "http://i.gifme.io/gifme/thumb__054a29890b4ccb9d3a2d.gif"
    }
}