Javascript API to fetch gifs and stickers from the GIPHY API.
Get started with your own api key: https://developers.giphy.com/docs/
import { GiphyFetch } from '@giphy/js-fetch-api'
const gf = new GiphyFetch('your api key')
// fetch 10 gifs
const { data: gifs } = await gf.trending({ limit: 10 })
Search all Giphy GIFs for a word or phrase. Punctuation will be stripped and ignored.
search(term: string, options?: SearchOptions): Promise<GifsResult>
option | type | description | default |
---|---|---|---|
lang | string | See list of supported languages here. | en |
sort | number | Specifies the starting position of the results. | recent |
Other Options: Type Option, Rating Option, Pagination Options
const { data: gifs } = await gf.search('dogs', { sort: 'relevant', lang: 'es', limit: 10, type: 'stickers' })
Fetch GIFs currently trending online. Hand curated by the Giphy editorial team. The data returned mirrors the GIFs showcased on the Giphy homepage.
trending(options?: TrendingOptions): Promise<GifsResult>
Trending Options: Type Option, Rating Option, Pagination Options
const { data: gifs } = await gf.trending({ limit: 10, offset: 25, rating: 'g' })
Fetch a gif by id
gif(id: string): Promise<GifResult>
const { data: gif } = await gf.gif('3oEjHGr1Fhz0kyv8Ig')
// by id
gifs(ids: string[]): Promise<GifsResult>
// by category and subcatetory
gifs(category: string, subcategory: string): Promise<GifsResult>
// by id
const { data: gifs } = await gf.gifs(['3oEjHGr1Fhz0kyv8Ig'])
// by category and subcatetory
const { data: gifs } = await gf.gifs('tv', 'arrested-development')
Fetch related gifs based on the id of a gif
related(id: string, options?: RelatedOptions): Promise<GifsResult>
Options: Pagination Options
const { data: gifs } = await gf.related('3oEjHGr1Fhz0kyv8Ig', { limit: 10 })
Fetch emoji. Emoji are stickers from a currated channel. There's no search or trending emoji.
emoji(options?: PaginationOptions): Promise<GifsResult>
Emoji Options: Pagination Options
const { data: gifs } = await gf.emoji()
Returns a random single GIF
random(options?: RandomOptions): Promise<GifResult>
option | type | description | default |
---|---|---|---|
tag | string | The GIF tag to limit randomness by. | undefined |
Other Options: Type Option
const { data: gif } = await gf.random({ tag: 'beer', type: 'stickers' })
categories(options?: CategoriesOptions): Promise<CategoriesResult>
const { data: categories } = await gf.categories()
categories.forEach(category => {
console.log(category) // ICategory
})
Options: Pagination Options
subcategories(category: string, options?: SubcategoriesOptions): Promise<CategoriesResult>
// Example:
const { data: categories } = await gf.subcategories('tv', { limit: 10, offset: 25, rating: 'g' })
categories.forEach(category => {
console.log(category) // ICategory
})
Options: Pagination Options
option | type | description | default |
---|---|---|---|
limit | number | Number of results to return, maximum 100 | 25 |
offset | number | Specifies the starting position of the results. | 0 |
option | type | description | default |
---|---|---|---|
rating | string | limit results by rating: y, g, pg, pg-13, r. | g |
option | type | description | default |
---|---|---|---|
type | string | gifs / stickers / text | gifs |