Imgur-API
view release on metacpan or search on metacpan
data/endpoints.json view on Meta::CPAN
"params" : {
"window" : {
"required" : 0,
"desc" : "Change the date range of the request if the sort is \"top\", day | week | month | year | all, defaults to week"
},
"sort" : {
"required" : 0,
"desc" : "viral | time | top - defaults to viral"
},
"page" : {
"desc" : "integer - the data paging number",
"required" : 0
},
"topic_id" : {
"desc" : "The ID or URL-formatted name of the topic. If using a topic's name, replace its spaces with underscores (Mother's_Day).",
"required" : 1
}
},
"sub" : "galleryTopic",
"name" : "Gallery Topic",
"url" : {
"base" : "3/topics/%s",
"optional" : "'sort','page'",
"required" : "'topic_id'"
}
},
{
"params" : {
"item_id" : {
"desc" : "The ID for the gallery item.",
"required" : 1
},
"topic_id" : {
"required" : 1,
"desc" : "The ID or URL-formatted name of the topic. If using a topic's name, replace its spaces with underscores (Mother's_Day)."
}
},
"method" : "get",
"sub" : "galleryTopicItem",
"description" : "View a single item in a gallery topic",
"url_params" : {},
"name" : "Gallery Topic Item",
"url" : {
"base" : "3/topics/%s/%s",
"required" : "'topic_id','item_id'",
"optional" : ""
}
}
],
"Account" : [
{
"method" : "get",
"sub" : "get",
"params" : {
"username" : {
"required" : 1,
"desc" : "Username"
}
},
"url_params" : {},
"description" : " Request standard user information. If you need the username for the account that is logged in, it is returned in the request for an access token. Note: This endpoint also supports the ability to lookup account base info by ...
"name" : "Account Base",
"url" : {
"optional" : "",
"required" : "'username'",
"base" : "3/account/%s"
}
},
{
"name" : "Account Gallery Favorites",
"url" : {
"base" : "3/account/%s/gallery_favorites",
"required" : "'username'",
"optional" : "'page','sort'"
},
"url_params" : {},
"description" : "Return the images the user has favorited in the gallery.",
"method" : "get",
"sub" : "galleryFavorites",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
},
"page" : {
"required" : 0,
"desc" : "integer - allows you to set the page number so you don't have to retrieve all the data at once."
},
"sort" : {
"required" : 0,
"desc" : "'oldest', or 'newest'. Defaults to 'newest'."
}
}
},
{
"method" : "get",
"sub" : "favorites",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
},
"page" : {
"required" : 0,
"desc" : "integer - allows you to set the page number so you don't have to retrieve all the data at once."
},
"sort" : {
"required" : 0,
"desc" : "'oldest', or 'newest'. Defaults to 'newest'."
}
},
"url_params" : {},
"description" : "Returns the users favorited images, only accessible if you're logged in as the user.",
"name" : "Account Favorites",
"url" : {
"base" : "3/account/%s/favorites",
"optional" : "'page','sort'",
"required" : "'username'"
}
},
{
data/endpoints.json view on Meta::CPAN
"username" : {
"required" : 1,
"desc" : "Username"
}
},
"description" : "Return the images a user has submitted to the gallery",
"url_params" : {}
},
{
"method" : "get",
"sub" : "settings",
"params" : {
"username" : {
"required" : 1,
"desc" : "Username"
}
},
"url_params" : {},
"description" : "Returns the account settings, only accessible if you're logged in as the user.",
"url" : {
"base" : "3/account/%s/settings",
"optional" : "",
"required" : "'username'"
},
"name" : "Account Settings"
},
{
"url_params" : {},
"description" : "Updates the account settings for a given user, the user must be logged in.",
"params" : {
"newsletter_subscribed" : {
"required" : 0,
"desc" : "true | false - Toggle subscription to email newsletter."
},
"accepted_gallery_terms" : {
"required" : 0,
"desc" : "true | false - The user agreement to the Imgur Gallery terms."
},
"bio" : {
"desc" : "The biography of the user, is displayed in the gallery profile page.",
"required" : 0
},
"album_privacy" : {
"required" : 0,
"desc" : "public | hidden | secret - Sets the default privacy level of albums the users creates"
},
"messaging_enabled" : {
"required" : 0,
"desc" : "true | false - Allows the user to enable / disable private messages"
},
"username" : {
"required" : 0,
"desc" : "A valid Imgur username (between 4 and 63 alphanumeric characters)"
},
"public_images" : {
"desc" : "Set the users images to private or public by default",
"required" : 0
},
"show_mature" : {
"required" : 0,
"desc" : "true | false - Toggle display of mature images in gallery list endpoints."
}
},
"method" : "put | post",
"sub" : "updateSettings",
"url" : {
"optional" : "",
"required" : "",
"base" : ""
},
"name" : "Change Account Settings"
},
{
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
}
},
"method" : "get",
"sub" : "profile",
"description" : "Returns the totals for the gallery profile.",
"url_params" : {},
"name" : "Account Gallery Profile",
"url" : {
"base" : "3/account/%s/gallery_profile",
"required" : "'username'",
"optional" : ""
}
},
{
"method" : "get",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
}
},
"sub" : "verifyEmail",
"description" : "Checks to see if user has verified their email address",
"url_params" : {},
"name" : "Verify User's E-mail",
"url" : {
"base" : "3/account/%s/verifyemail",
"optional" : "",
"required" : "'username'"
}
},
{
"name" : "Send Verification E-mail",
"url" : {
"required" : "'username'",
"optional" : "",
"base" : "3/account/%s/verifyemail"
},
"url_params" : {},
"description" : "Sends an email to the user to verify that their email is valid to upload to gallery. Must be logged in as the user to send.",
"sub" : "sendVerifyEmail",
"method" : "post",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
}
}
},
{
"params" : {
"page" : {
"desc" : "integer - allows you to set the page number so you don't have to retrieve all the data at once.",
"required" : 0
},
"username" : {
"required" : 1,
"desc" : "Username"
}
},
"method" : "get",
"sub" : "albums",
"description" : " Get all the albums associated with the account. Must be logged in as the user to see secret and hidden albums. ",
"url_params" : {},
"name" : "Albums",
"url" : {
"base" : "3/account/%s/albums",
"required" : "'username'",
"optional" : "'page'"
}
},
{
"url_params" : {},
"description" : " Get additional information about an album, this endpoint works the same as the Album Endpoint. You can also use any of the additional routes that are used on an album in the album endpoint. ",
"method" : "get",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
},
"account" : {
"desc" : "Account",
"required" : 1
}
},
"sub" : "album",
"name" : "Album",
"url" : {
"base" : "3/account/%s/album/%s",
"optional" : "",
"required" : "'username','account'"
}
},
{
"name" : "Album IDs",
"url" : {
"optional" : "'page'",
"required" : "'username'",
"base" : "3/account/%s/albums/ids"
},
"method" : "get",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
},
"page" : {
"required" : 0,
"desc" : "integer - allows you to set the page number so you don't have to retrieve all the data at once."
}
},
"sub" : "albumIds",
"description" : "Return an array of all of the album IDs.",
"url_params" : {}
},
{
"url_params" : {},
"description" : "Return the total number of albums associated with the account.",
"method" : "get",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
}
},
"sub" : "albumCount",
"url" : {
"base" : "3/account/%s/albums/count",
"optional" : "",
"required" : "'username'"
},
"name" : "Album Count"
},
{
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
},
"account" : {
"desc" : "Account",
"required" : 1
}
},
"method" : "delete",
"sub" : "albumDelete",
"description" : "Delete an Album with a given id.",
"url_params" : {},
"name" : "Album Deletion",
"url" : {
"base" : "3/account/%s/album/%s",
"required" : "'username','account'",
"optional" : ""
}
},
{
"url_params" : {},
"description" : "Return the comments the user has created.",
"params" : {
"sort" : {
"required" : 0,
"desc" : "'best', 'worst', 'oldest', or 'newest'. Defaults to 'newest'."
},
"username" : {
"required" : 1,
"desc" : "Username"
},
"page" : {
"desc" : "Page number (50 items per page). Defaults to 0.",
"required" : 0
}
},
"method" : "get",
"sub" : "comments",
"url" : {
"base" : "3/account/%s/comments",
"required" : "'username'",
"optional" : "'sort','page'"
},
"name" : "Comments"
},
{
"method" : "get",
"sub" : "comment",
"params" : {
"account" : {
"desc" : "Account",
"required" : 1
},
"username" : {
"desc" : "Username",
"required" : 1
}
},
"description" : " Return information about a specific comment. This endpoint works the same as the Comment Endpoint. You can use any of the additional actions that the comment endpoint allows on this end point. ",
"url_params" : {},
"url" : {
"optional" : "",
"required" : "'username','account'",
"base" : "3/account/%s/comment/%s"
},
"name" : "Comment"
},
{
"sub" : "commentIds",
"method" : "get",
"params" : {
"sort" : {
"desc" : "'best', 'worst', 'oldest', or 'newest'. Defaults to 'newest'.",
"required" : 0
},
"page" : {
"required" : 0,
"desc" : "Page number (50 items per page). Defaults to 0."
},
"username" : {
"desc" : "Username",
"required" : 1
}
},
"url_params" : {},
"description" : "Return an array of all of the comment IDs.",
"url" : {
"base" : "3/account/%s/comments/ids",
"optional" : "'sort','page'",
"required" : "'username'"
},
"name" : "Comment IDs"
},
{
"name" : "Comment Count",
"url" : {
"optional" : "",
"required" : "'username'",
"base" : "3/account/%s/comments/count"
},
"sub" : "commentCount",
"method" : "",
"params" : {
"username" : {
"required" : 1,
"desc" : "Username"
}
},
"description" : "Return a count of all of the comments associated with the account.",
"url_params" : {}
},
{
"url" : {
"required" : "'username','account'",
"optional" : "",
"base" : "3/account/%s/comment/%s"
},
"name" : "Comment Deletion",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
},
"account" : {
"required" : 1,
"desc" : "Account"
}
},
"method" : "delete",
"sub" : "commentDelete",
"description" : "Delete a comment. You are required to be logged in as the user whom created the comment.",
"url_params" : {}
},
{
"url" : {
"required" : "'username','page'",
"optional" : "",
"base" : "3/account/%s/images/%s"
},
"name" : "Images",
"method" : "get",
"sub" : "images",
"params" : {
"page" : {
"required" : 1,
"desc" : "Page"
},
"username" : {
"required" : 1,
"desc" : "Username"
}
},
"url_params" : {},
"description" : " Return all of the images associated with the account. You can page through the images by setting the page, this defaults to 0. "
},
{
"description" : " Return information about a specific image. This endpoint works the same as the Image Endpoint. You can use any of the additional actions that the image endpoint with this endpoint. ",
"url_params" : {},
"method" : "get",
"sub" : "image",
"params" : {
"account" : {
"desc" : "Account",
"required" : 1
},
"username" : {
"desc" : "Username",
"required" : 1
}
},
"url" : {
"optional" : "",
"required" : "'username','account'",
"base" : "3/account/%s/image/%s"
},
"name" : "Image"
},
{
"name" : "Image IDs",
"url" : {
"optional" : "'page'",
"required" : "'username'",
"base" : "3/account/%s/images/ids"
},
"method" : "get",
"params" : {
"username" : {
"required" : 1,
"desc" : "Username"
},
"page" : {
"desc" : "integer - allows you to set the page number so you don't have to retrieve all the data at once.",
"required" : 0
}
},
"sub" : "imageIds",
"description" : " Returns an array of Image IDs that are associated with the account. ",
"url_params" : {}
},
{
"method" : "get",
"sub" : "imageCount",
"params" : {
"username" : {
"desc" : "Username",
"required" : 1
}
},
"url_params" : {},
"description" : " Returns the total number of images associated with the account. ",
"url" : {
"required" : "'username'",
"optional" : "",
"base" : "3/account/%s/images/count"
},
"name" : "Image Count"
},
data/endpoints.json view on Meta::CPAN
},
{
"description" : "Search the gallery with a given query string.",
"url_params" : {},
"sub" : "search",
"method" : "get",
"params" : {
"page" : {
"required" : 0,
"desc" : "integer - the data paging number"
},
"window" : {
"desc" : "Change the date range of the request if the sort is 'top', day | week | month | year | all, defaults to all.",
"required" : 0
},
"sort" : {
"desc" : "time | viral | top - defaults to time",
"required" : 0
}
},
"name" : "Gallery Search",
"url" : {
"optional" : "'sort','window','page'",
"required" : "",
"base" : "3/gallery/search"
}
},
{
"description" : "Returns a random set of gallery images.",
"url_params" : {},
"method" : "get",
"sub" : "random",
"params" : {
"page" : {
"desc" : "A page of random gallery images, from 0-50. Pages are regenerated every hour.",
"required" : 0
}
},
"url" : {
"base" : "3/gallery/random/random",
"optional" : "'page'",
"required" : ""
},
"name" : "Random Gallery Images"
},
{
"name" : "Share with community",
"url" : {
"required" : "'gallery'",
"optional" : "",
"base" : "3/gallery/%s"
},
"sub" : "toGallery",
"method" : "post | put",
"params" : {
"mature" : {
"required" : 0,
"desc" : "If the post is mature, set this value to 1."
},
"terms" : {
"desc" : "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.",
"required" : 0
},
"title" : {
"desc" : "The title of the image. This is required.",
"required" : 1
},
"gallery" : {
"required" : 1,
"desc" : "Gallery"
},
"tags[]" : {
"desc" : "The name of the tags you wish to associate with a post. Can be passed as tags[]=funny&tags[]=cat or tags=funny,cat",
"required" : 0
},
"topic" : {
"desc" : "Topic name",
"required" : 0
}
},
"description" : "Share an Album or Image to the Gallery.",
"url_params" : {}
},
{
"url_params" : {},
"description" : "Remove an image from the gallery. You must be logged in as the owner of the item to do this action.",
"method" : "delete",
"sub" : "fromGallery",
"params" : {
"gallery" : {
"required" : 1,
"desc" : "Gallery"
}
},
"name" : "Remove from Gallery",
"url" : {
"base" : "3/gallery/%s",
"required" : "'gallery'",
"optional" : ""
}
},
{
"name" : "Album",
"url" : {
"required" : "'gallery'",
"optional" : "",
"base" : "3/gallery/album/%s"
},
"params" : {
"gallery" : {
"desc" : "Gallery",
"required" : 1
}
},
"method" : "get",
"sub" : "album",
"url_params" : {},
"description" : "Get additional information about an album in the gallery."
},
{
"name" : "Image",
( run in 1.393 second using v1.01-cache-2.11-cpan-d7f47b0818f )