Developer API
The primary purpose of this website is to build a public database of GIFs hosted on IPFS that anyone is free to search through. We host a simple API that any client can use to find GIFs without the need for authentication or an API key.
Note that the API may impose rate limiting based on IP address in order to prevent bot abuse. When the user is being rate limited, the API should return a status code of 429, and the response body cannot be expected to be in any specific format.
Searching for GIFs
GIFs are organized by search terms called "tags". When the user searches for a GIF, the tags are used to match search terms.
Request Method: GET
Request URL: https://gif.reeksite.com/api/v1/search
Request Query Parameters:
| q | The search text used to find a GIF. |
Response Body Example:
{
"media": [
{
"cid": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789",
"filename": "example1.gif",
"description": "Dog fetching a frisbee"
},
{
"cid": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456780",
"filename": "example2.gif",
"description": "Flying a kite"
}
]
}
The "cid" is the content ID of the GIF as hosted on IPFS. You can build a link to the GIF by using any IPFS gateway of your choice. For example, using the demo search response above:
https://ipfs.io/ipfs/ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789?filename=example1.gif
Find GIFs for a Tag
GIFs may be retrieved for one specific tag at a time.
Tags are alphanumeric and lower-case. They may contain multiple space or dash separated words.
Request Method: GET
Request URL: https://gif.reeksite.com/api/v1/tag/{tagName}
Request Path Parameters:
| tagName |
The name of the tag to retrieve a list of GIFs for, for example: https://gif.reeksite.com/api/v1/tag/outdoor-activities |
Response Body Example:
{
"media": [
{
"cid": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789",
"filename": "example1.gif",
"description": "Dog fetching a frisbee"
},
{
"cid": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456780",
"filename": "example2.gif",
"description": "Flying a kite"
}
]
}
The response body is in the same format as the search API.
Find Popular GIFs
A list of the most popular GIFs may be retrieved.
Request Method: GET
Request URL: https://gif.reeksite.com/api/v1/popular
Response Body Example:
{
"media": [
{
"cid": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789",
"filename": "example1.gif",
"description": "Dog fetching a frisbee"
},
{
"cid": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456780",
"filename": "example2.gif",
"description": "Flying a kite"
}
]
}
The response body is in the same format as the search API.