@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Giphy API
@base https://api.giphy.com/v1
@version 1.0
@auth ApiKey api_key in query
@endpoints 10
@toc gifs(6), stickers(4)

@group gifs
@endpoint GET /gifs/search
@desc Search GIFs
@required {q: any # Search query term or prhase.}
@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating., lang: any # Specify default language for regional content; use a 2-letter ISO 639-1 language code.}
@returns(200) Search results
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /gifs/trending
@desc Trending GIFs
@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /gifs/translate
@desc Translate phrase to GIF
@required {s: any # Search term.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /gifs/random
@desc Random GIF
@optional {tag: any # Filters results by specified tag., rating: any # Filters results by specified rating.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /gifs/{gifId}
@desc Get GIF by Id
@required {gifId: any # Filters results by specified GIF ID.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /gifs
@desc Get GIFs by ID
@optional {ids: any # Filters results by specified GIF IDs, separated by commas.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endgroup

@group stickers
@endpoint GET /stickers/search
@desc Search Stickers
@required {q: any # Search query term or prhase.}
@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating., lang: any # Specify default language for regional content; use a 2-letter ISO 639-1 language code.}
@returns(200) Search results
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /stickers/trending
@desc Trending Stickers
@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /stickers/translate
@desc Translate phrase to Sticker
@required {s: any # Search term.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endpoint GET /stickers/random
@desc Random Sticker
@optional {tag: any # Filters results by specified tag., rating: any # Filters results by specified rating.}
@returns(200)
@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}

@endgroup

@end