Sign in

Get a json object containing a list of the most relevant GIFs for a given search term(s), category(ies), emoji(s), or any combination thereof.

get/v1/search

Query parameters

qstring required

a search string

keystring required

client key for privileged API access

localestring

specify default language to interpret search string; xx is ISO 639-1 language code, _YY (optional) is 2-letter ISO 3166-1 country code

contentfilter'off' | 'low' | 'medium' | 'high'

(values: off | low | medium | high) specify the content safety filter level

media_filter'basic' | 'minimal'

(values: basic | minimal) Reduce the Number of GIF formats returned in the GIF_OBJECT list.

minimal - tinygif, gif, and mp4.

basic - nanomp4, tinygif, tinymp4, gif, mp4, and nanogif

ar_range'all' | 'wide' | 'standard'

(values: all | wide | standard ) Filter the response GIF_OBJECT list to only include GIFs with aspect ratios that fit with in the selected range.

all - no constraints

wide - 0.42 <= aspect ratio <= 2.36

standard - .56 <= aspect ratio <= 1.78

limitinteger

fetch up to a specified number of results (max: 50).

posstring

get results starting at position "value". Use a non-zero "next" value returned by API results to get the next set of results. pos is not an index and may be an integer, float, or string

anon_idstring

specify the anonymous_id tied to the given user

Response

search results

nextstring required

a position identifier to use with the next API query to retrieve the next set of results, or null if there are no further results.

Changes

No recorded changes to this endpoint across all 1 revision of this API.