Michael Hollenbeck
and 1 contributors

NAME

Imgur::API::Endpoint::Gallery

DESCRIPTION

    Access to the imgur Gallery API Endpoint.

METHODS

get

    Returns the images in the gallery. For example the main gallery is https://api.imgur.com/3/gallery/hot/viral/0.json

Parameters

  • sort optional

    viral | top | time | rising (only available with user section) - defaults to viral

  • window optional

    Change the date range of the request if the section is "top", day | week | month | year | all, defaults to day

  • section optional

    hot | top | user - defaults to hot

  • showViral optional

    true | false - Show or hide viral images from the 'user' section. Defaults to true

  • page optional

    integer - the data paging number

memeSubgallery

    View images for memes subgallery

Parameters

  • sort optional

    viral | time | top - defaults to viral

  • window optional

    Change the date range of the request if the sort is "top", day | week | month | year | all, defaults to week

  • page optional

    integer - the data paging number

memeSubgalleryImage

    View a single image in the memes gallery

Parameters

  • image_id required

    The ID for the image.

subreddit

    View gallery images for a subreddit

Parameters

  • window optional

    Change the date range of the request if the sort is "top", day | week | month | year | all, defaults to week

  • sort optional

    time | top - defaults to time

  • page optional

    integer - the data paging number

  • subreddit required

    pics - A valid subreddit name

subredditImage

    View a single image in the subreddit

Parameters

  • image_id required

    The ID for the image.

  • subreddit required

    pics - A valid subreddit name

tag

    View images for a gallery tag

Parameters

  • t_name required

    The name of the tag.

  • window optional

    Change the date range of the request if the sort is "top", day | week | month | year | all, defaults to week

  • sort optional

    viral | time | top - defaults to viral

  • page optional

    integer - the data paging number

tagImage

    View a single image in a gallery tag

Parameters

  • t_name required

    The name of the tag.

  • image_id required

    The ID for the image.

itemTags

    View tags for a gallery item

Parameters

  • gallery required

    Gallery

  • id required

    ID of the gallery item

tagVote

    Vote for a tag, 'up' or 'down' vote. Send the same value again to undo a vote.

Parameters

  • t_name required

    Name of the tag (implicitly created, if doesn't exist)

  • vote required

    'up' or 'down'

  • gallery required

    Gallery

  • id required

    ID of the gallery item

updateGalleryTags

    Update the tags for a post in the gallery

Parameters

  • id required

    ID of the gallery item

  • tags required

    The name of the tags you wish to associate with a post. Can be passed as tags[]=funny&tags[]=cat or tags=funny,cat/td>

  • gallery required

    Gallery

    Search the gallery with a given query string.

Parameters

  • page optional

    integer - the data paging number

  • window optional

    Change the date range of the request if the sort is 'top', day | week | month | year | all, defaults to all.

  • sort optional

    time | viral | top - defaults to time

random

    Returns a random set of gallery images.

Parameters

  • page optional

    A page of random gallery images, from 0-50. Pages are regenerated every hour.

toGallery

    Share an Album or Image to the Gallery.

Parameters

  • title required

    The title of the image. This is required.

  • topic optional

    Topic name

  • tags[] optional

    The name of the tags you wish to associate with a post. Can be passed as tags[]=funny&tags[]=cat or tags=funny,cat

  • mature optional

    If the post is mature, set this value to 1.

  • terms optional

    If the user has not accepted our terms yet, this endpoint will return an error. To by-pass the terms in general simply set this value to 1.

  • gallery required

    Gallery

fromGallery

    Remove an image from the gallery. You must be logged in as the owner of the item to do this action.

Parameters

  • gallery required

    Gallery

album

    Get additional information about an album in the gallery.

Parameters

  • gallery required

    Gallery

image

    Get additional information about an image in the gallery.

Parameters

  • gallery required

    Gallery

reporting

    Report an Image in the gallery

Parameters

  • 3 required

  • 4 required

  • 5 required

  • 1 required

  • reason optional

    An integer representing the reason for the report Value Description 1 Doesn't belong on Imgur 2 Spam 3 Abusive 4 Mature content not marked as mature 5 Pornography

  • 2 required

votes

    Get the vote information about an image

Parameters

  • gallery required

    Gallery

voting

    Vote for an image, 'up' or 'down' vote. Send 'veto' to undo a vote.

Parameters

  • vote required

    Vote

  • gallery required

    Gallery

comments

    Comment on an image in the gallery.

Parameters

  • sort optional

    best | top | new - defaults to best

  • gallery required

    Gallery

comment

    Information about a specific comment. This action also allows any of the additional actions provided in the Comment Endpoint.

Parameters

  • comment required

    Comment

  • gallery required

    Gallery

commentCreation

    Create a comment for an image.

Parameters

  • comment required

    The text of the comment.

  • gallery required

    Gallery

commentReply

    Reply to a comment that has been created for an image.

Parameters

  • comment required

    The text you want to use as the reply.

  • gallery required

    Gallery

  • commentReply required

    CommentReply

commentIds

    List all of the IDs for the comments on an image.

Parameters

  • gallery required

    Gallery

commentCount

    The number of comments on an Image.

Parameters

  • gallery required

    Gallery

SEE ALSO

    https://api.imgur.com/endpoints/gallery