module async_api.py🔗
function async_search_gifs🔗
async_search_gifs(
q: str,
lang: str = None,
rating: giphpy.enums.Rating = None,
limit: int = None,
offset: int = None,
api_key: str = None,
random_id: str = None,
bundle: giphpy.enums.Bundle = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifListResponse]
Search for gifs asynchronously by a query string.
https://developers.giphy.com/docs/api/endpoint#search
Args:
q: search query term or phraselang: specify language using a 2-letter ISO 639-1 language code.rating: filters results by specified ratinglimit: maximum number of objects to return. if not passed, 25offset: the starting position of results. if not passed, 0api_key: giphy api keyrandom_id: an ID/proxy for a specific user.bundle: returns only renditions that correspond to the named bundle.serialize: defaults to False. if True, returns aGifListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifListResponse if serialize is True, else httpx.Response
function async_search_stickers🔗
async_search_stickers(
q: str,
lang: str = None,
rating: giphpy.enums.Rating = None,
limit: int = None,
offset: int = None,
api_key: str = None,
random_id: str = None,
bundle: giphpy.enums.Bundle = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifListResponse]
Search for stickers asynchronously by using a query string.
https://developers.giphy.com/docs/api/endpoint#search
Args:
q: search query term or phraselang: specify language using a 2-letter ISO 639-1 language code.rating: filters results by specified ratinglimit: maximum number of objects to return. if not passed, 25offset: the starting position of results. if not passed, 0api_key: giphy api keyrandom_id: an ID/proxy for a specific user.bundle: returns only renditions that correspond to the named bundle.serialize: defaults to False. if True, returns aGifListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifListResponse if serialize is True, else httpx.Response
function async_trending_gifs🔗
async_trending_gifs(
rating: giphpy.enums.Rating = None,
limit: int = None,
offset: int = None,
api_key: str = None,
random_id: str = None,
bundle: giphpy.enums.Bundle = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifListResponse]
Get trending gifs asynchronously.
https://developers.giphy.com/docs/api/endpoint#trending
Args:
rating: filters results by specified ratinglimit: maximum number of objects to return. if not passed, 25offset: the starting position of results. if not passed, 0api_key: giphy api keyrandom_id: an ID/proxy for a specific user.bundle: returns only renditions that correspond to the named bundle.serialize: defaults to False. if True, returns aGifListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifListResponse if serialize is True, else httpx.Response
function async_trending_stickers🔗
async_trending_stickers(
rating: giphpy.enums.Rating = None,
limit: int = None,
offset: int = None,
api_key: str = None,
random_id: str = None,
bundle: giphpy.enums.Bundle = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifListResponse]
Get trending stickers asynchronously.
https://developers.giphy.com/docs/api/endpoint#trending
Args:
rating: filters results by specified ratinglimit: maximum number of objects to return. if not passed, 25offset: the starting position of results. if not passed, 0api_key: giphy api keyrandom_id: an ID/proxy for a specific user.bundle: returns only renditions that correspond to the named bundle.serialize: defaults to False. if True, returns aGifListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifListResponseif serialize is True, elsehttpx.Response`
function async_gif_translate🔗
async_gif_translate(
s: str,
api_key: str = None,
weirdness: int = None,
random_id: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifResponse]
Asynchronously translate words or phrases to a single gif.
https://developers.giphy.com/docs/api/endpoint#translate
Args:
s: search termapi_key: giphy api keyweirdness('int',optional): value from 0-10 which makes results weirder as you go up the scalerandom_id: an ID/proxy for a specific userserialize: defaults to False. if True, returns aGifResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifResponse if serialize is True, else httpx.Response
function async_sticker_translate🔗
async_sticker_translate(
s: str,
api_key: str = None,
weirdness: int = None,
random_id: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifResponse]
Asynchronously translate words or phrases to a single sticker.
https://developers.giphy.com/docs/api/endpoint#translate
Args:
s: search termapi_key: giphy api keyweirdness('int',optional): value from 0-10 which makes results weirder as you go up the scalerandom_id: an ID/proxy for a specific userserialize: defaults to False. if True, returns aGifResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifResponse if serialize is True, else httpx.Response
function async_random_gif🔗
async_random_gif(
api_key: str = None,
tag: str = None,
rating: giphpy.enums.Rating = None,
random_id: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifResponse]
Get a single random GIF asynchronously
https://developers.giphy.com/docs/api/endpoint#random
Args:
api_key: giphy api keytag('str,optional`): filter results by a specified tagrating: filters results by specified ratingrandom_id: an ID/proxy for a specific userserialize: defaults to False. if True, returns aGifResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifResponse if serialize is True, else httpx.Response
function async_random_sticker🔗
async_random_sticker(
api_key: str = None,
tag: str = None,
rating: giphpy.enums.Rating = None,
random_id: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifResponse]
Get a single random sticker asynchronously
https://developers.giphy.com/docs/api/endpoint#random
Args:
api_key: giphy api keytag('str,optional`): filter results by a specified tagrating: filters results by specified ratingrandom_id: an ID/proxy for a specific userserialize: defaults to False. if True, returns aGifResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifResponse if serialize is True, else httpx.Response
function async_random_id🔗
async_random_id(
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.RandomIdResponse]
Asynchronously generate a unique ID you can assign to each new user in your app.
https://developers.giphy.com/docs/api/endpoint#random-id
Args:
api_key: giphy api keyserialize: defaults to False. if True, returns aRandomIdResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
RandomIdResponse if serialize is True, else httpx.Response
function async_action_register🔗
async_action_register(
url: str,
random_id: str,
ts: int,
api_key: str = None,
**kwargs
) → Response
Asynchronously Register an impression, click, or send sing a callback url from the analytics object.
https://developers.giphy.com/docs/api/endpoint#action-register
Args:
url: an impression, on click, or send callback url from the analytics objectrandom_id: an id/proxy for a specific userts: a unix timestamp in milliseconds corresponding to when the action occurredapi_key: giphy api key**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
httpx.Response
function async_get_gif_by_id🔗
async_get_gif_by_id(
gif_id: str,
api_key: str = None,
random_id: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.GifResponse]
Get a single gif asynchronously by its unique identifier
https://developers.giphy.com/docs/api/endpoint#get-gif-by-id
Args:
gif_id: the unique identifier of the gif you want details forapi_key: giphy api keyrandom_id: an id/proxy for a specific userserialize: defaults to False. if True, returns aGifResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifResponse if serialize is True, else httpx.Response
function async_get_gifs_by_id🔗
async_get_gifs_by_id(
*gif_ids: str,
api_key: str = None,
random_id: str = None,
serialize: bool = None,
**kwargs
) → Union[httpx.Response, giphpy.models.GifListResponse]
Get one or more gifs asynchronously by their unique identifiers.
https://developers.giphy.com/docs/api/endpoint#get-gifs-by-id
Args:
*gif_ids: any number of unique identifiers for gifs you want details forapi_key: giphy api keyrandom_id: an id/proxy for a specific userserialize: defaults to False. if True, returns aGifListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
GifListResponse if serialize is True, else httpx.Response
function async_categories🔗
async_categories(
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.CategoryListResponse]
Asynchronously get a list of gif categories on the giphy network.
https://developers.giphy.com/docs/api/endpoint#categories
Args:
api_key: giphy api keyserialize: defaults to False. if True, returns aCategoryListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
CategoryListResponse if serialize is True, else httpx.Response
function async_autocomplete🔗
async_autocomplete(
q: str,
api_key: str = None,
limit: int = None,
offset: int = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.SearchTermListResponse]
Asynchronously provides a list of valid terms that completes the given tag on the giphy network
https://developers.giphy.com/docs/api/endpoint#autocomplete
Args:
q: tag termapi_key: giphy api keylimit: maximum number of objects to return. if not passed, 25offset: the starting position of results. if not passed, 0serialize: defaults to False. if True, returns aSearchTermListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
SearchTermListResponse if serialize is True, else httpx.Response
function async_channel_search🔗
async_channel_search(
q: str,
api_key: str = None,
limit: int = None,
offset: int = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.ChannelListResponse]
Asynchronously returns all the giphy channels matching the query term.
https://developers.giphy.com/docs/api/endpoint#channel-search
Args:
q: accepts term to search through giphy’s channelsapi_key: giphy api keylimit: maximum number of objects to return. if not passed, 25offset: the starting position of results. if not passed, 0serialize: defaults to False. if True, returns aChannelListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
ChannelListResponse if serialize is True, else httpx.Response
function async_search_suggestions🔗
async_search_suggestions(
term: str,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, giphpy.models.TermListResponse]
Asynchronously provides a list of tag terms related to the given tag on the giphy network.
https://developers.giphy.com/docs/api/endpoint#search-suggestions
Args:
term: tag termapi_key: giphy api keyserialize: defaults to False. if True, returns aTermListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
TermListResponse if serialize is True, else httpx.Response
function async_trending_search_terms🔗
async_trending_search_terms(
api_key: str = None,
serialize: bool = False,
**kwargs
)
Asynchronously provides a list of the most popular trending search terms on the giphy network.
https://developers.giphy.com/docs/api/endpoint#trending-search-terms
Args:
api_key: giphy api keyserialize: defaults to False. if True, returns aTermListResponseobject**kwargs: additional kwargs to pass down tohttpx.AsyncClient.get
Returns:
TrendingSearchTermsListResponse if serialize is True, else httpx.Response