imgur

Authorization header

The value of the Authorization header should be the string "Client-ID <YOUR-CLIENT-ID>".

Current Account

To make requests for the current account, you may use me as the {username} parameter. For example, https://api.imgur.com/3/account/me/images will request all the images for the account that is currently authenticated.

account

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.

Request:

GET /account/{username}
Authorization: {}

account-create

Create a new user on Imgur.

Note: You you MUST send recaptcha information with this request.

Use this as the public captcha key: 6Lf7R8USAAAAAIkTcbhc8Di49orfHUuExshF9z8I.

Request:

POST /account/{username}
Authorization: {}

account-delete

Delete a user account, you can only access this if you're logged in as the user.

Request:

DELETE /account/{username}
Authorization: {}

account-likes

Return an array of images that have been upvoted by the user.

Reqest:

GET /account/{username}/likes
Authorization: {}

account-submissions

Return the images a user has submitted to the gallery.

Request:

GET /account/{username}/submissions/{page}
Authorization: {}

account-settings

Returns the account settings, only accessible if you're logged in as the user.

Request:

GET /account/{username}/settings
Authorization: {}

account-stats

Return the statistics about the account.

Request:

GET /account/{username}/stats
Authorization: {}

account-profile

Returns the totals for the gallery profile.

Request:

GET /account/{username}/gallery_profile
Authorization: {}

account-albums

Get all the albums associated with the account. Must be logged in as the user to see secret and hidden albums.

Request:

GET /account/{username}/albums/{page}
Authorization: {}

Parameters

Key	Required	Description
page	optional	integer - allows you to set the page number so you don't have to retrieve all the data at once.

account-get-album

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.

Request:

GET /account/{username}/album/{id}
Authorization: {}

album-ids

Return an array of all of the album IDs.

Request:

GET /account/{username}/albums/ids
Authorization: {}

album-count

Return the total number of albums associated with the account.

Request:

GET /account/{username}/albums/count
Authorization: {}

account-album-delete

Delete an Album with a given id.

Request:

DELETE /account/{username}/album/{id}
Authorization: {}

comments

Return the comments the user has created.

Request:

GET /account/{username}/comments
Authorization: {}

comment

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.

Request:

GET /account/{username}/comment/{id}
Authorization: {}

comment-ids

Return an array of all of the comment IDs.

Request:

GET /account/{username}/comments/ids
Authorization: {}

comment-count

Return a count of all of the comments associated with the account.

Request:

GET /account/{username}/comments/count
Authorization: {}

account-comment-delete

Delete a comment. You are required to be logged in as the user whom created the comment.

Request:

DELETE /account/{username}/comment/{id}
Authorization: {}

images

Return all of the images associated with the account. You can page through the images by setting the page, this defaults to 0.

Request:

GET /account/{username}/images/{page}
Authorization: {}

account-image

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.

Request:

GET /account/{username}/image/{id}
Authorization: {}

image-ids

Returns an array of Image IDs that are associated with the account.

Request:

GET /account/{username}/images/ids
Authorization: {}

image-count

Returns the total number of images associated with the account.

Request:

GET /account/{username}/images/count
Authorization: {}

account-image-delete

Deletes an Image. This requires a delete hash rather than an ID.

Request:

DELETE /account/{username}/image/{deletehash}
Authorization: {}

account-notifications

Return all of the notifications associated with the account. Defaults to return only new notifications, however you can set the GET variable, new, to false to return all of the notifications. You're required to be logged in as the user to view this information.

Request:

GET /account/{username}/notifications
    ?[new=true]
Authorization: {}

Parameters

Key	Required	Value
new	optional	boolean - false for all notifications, true for only non-viewed notification. Default is true.

account-messages

Returns all messages sent to the user, formatted as a notification. Required to be logged in to view this information.

Request:

GET /account/{username}/notifications/messages
    ?[new=true]
Authorization: {}

Parameters

Key	Required	Value
new	optional	boolean - false for all notifications, true for only non-viewed notification. Default is true.

messages-send

Send a message to the user in the URL from the user that's currently logged in. Set the variables subject (the subject of the message) and body (the body of the message) accordingly. A user must be logged in to send a message to another user.

Request:

POST /account/{username}/message
    ?body={}
    &[subject={}]
    &[parent_id={}]
Authorization: {}

Parameters

Key	Required	Value
body	required	The text of the message. Similar to the body of an email.
subject	optional	The subject of the message
parent_id	optional	The ID of the first message in the thread, by setting this, the message will be threaded to the given message.

replies

Returns all of the reply notifications for the user. Required to be logged in as that user.

Request:

GET /account/{username}/notifications/replies
    ?[new=true]
Authorization: {}

Parameters

Key	Required	Value
new	optional	boolean - false for all notifications, true for only non-viewed notification. Default is true.

album-get

Get information about a specific album.

Request:

GET /album/{id}
Authorization: {}

album-images

Return all of the images in the album

Request:

GET /album/{id}/images
Authorization: {}

album-image

Get information about an image in an album, any additional actions found in Image Endpoint will also work.

Request:

GET /album/{id}/image/{id}
Authorization: {}

album-upload

Create a new album. optional parameter of ids[] is an array of image ids to add to the album.

Request:

POST /album/
    ?[ids={}]
    &[title={}]
    &[description={}]
    &[cover={}]
Authorization: {}

Parameters

Key	Required	Description
ids[]	optional	The image ids that you want to be included in the album.
title	optional	The title of the album
description	optional	The description of an album
cover	optional	The ID of an image that you want to be the cover of the album

album-update

Update the information of an album.

Request:

PUT /album/{id}
    ?[ids={}]
    &[title={}]
    &[description={}]
    &[cover={}]
Authorization: {}

Parameters

Key	Required	Description
ids[]	optional	The image ids that you want to be included in the album.
title	optional	The title of the album
description	optional	The description of an album
cover	optional	The ID of an image that you want to be the cover of the album

album-delete

Delete an album with a given ID. You are required to be logged in as the user to delete the album.

Request:

DELETE /album/{id}
Authorization: {}

album-set-to

Sets the images for an album, removes all other images and only uses the images in this request.

Request:

POST /album/{id}/
    ?ids={}
Authorization: {}

Parameters

Key	Required	Description
ids[]	required	The image ids that you want to be added to the album.

album-add-to

Takes parameter, ids[], as an array of ids to add to the album.

Request:

POST /album/{id}/add
    ?ids={}
Authorization: {}

Parameters

Key	Required	Description
ids[]	required	The image ids that you want to be added to the album.

album-remove-from

Takes parameter, ids[], as an array of ids and removes from the labum.

Request:

DELETE /album/{id}
    ?ids={}
Authorization: {}

Parameters

Key	Required	Description
ids[]	required	The image ids that you want to be added to the album.

comment" class="textbox">

Get information about a specific comment.

Request:

GET /comment/{id}
Authorization: {}

comment-create

Creates a new comment, returns the ID of the comment.

Request:

POST /comment
    ?image_id={}
    &comment={}
    &[parent_id={}]
Authorization: {}

Parameters

Key	Required	Description
image_id	required	The ID of the image in the gallery that you wish to comment on
comment	required	The comment text, this is what will be displayed
parent_id	optional	The ID of the parent comment, this is an alternative method to create a reply.

comment-delete

Delete a comment by the given id.

Request:

DELETE /comment/{id}
Authorization: {}

comment-replies

Get the comment with all of the replies for the comment.

Request:

GET /comment/{id}/replies
Authorization: {}

comment-vote

Vote on a comment. The {vote} variable can only be set as "up" or "down".

Request:

POST /comment/{id}/vote/{vote}
Authorization: {}

comment-report

Report a comment for being inappropriate.

Request:

POST /comment/{id}/report
Authorization: {}

comment-reply-create

Create a reply for the given comment.

Request:

POST /comment/{id}
    ?image_id={}
    &comment={}
Authorization: {}

Parameters

Key	Required	Description
image_id	required	The ID of the image in the gallery that you wish to comment on
comment	required	The comment text, this is what will be displayed

gallery

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

Request:

GET /gallery/{section}/{sort}/{page}
Authorization: {}

Parameters

Key	Required	Value
section	optional	viral \| score \| time - defaults to viral
sort	optional	hot \| top \| new - defaults to hot
page	optional	integer - the data paging number

subreddit

View gallery images for a sub-reddit

Request:

GET /gallery/r/{subreddit}/{sort}/{page}
Authorization: {}

Parameters

Key	Required	Value
subreddit	required	pics - A valid sub-reddit name
sort	optional	hot \| new - defaults to hot
page	optional	integer - the data paging number

gallery-serach

Search the gallery with a given query string.

Request:

GET /gallery/search
    ?q={}
Authorization: {}

Parameters

Key	Required	Value
q	required	Query string

to-gallery

Add an Album or Image to the Gallery.

Request:

POST /gallery/image/{id}
    ?title={}
    &[terms={}]
Authorization: {}

Parameters

Key	Required	Value
title	required	The title of the image. This is required.
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.

album

Get additional information about an album in the gallery.

Request:

GET /gallery/album/{id}
Authorization: {}

gallery-image

Get additional information about an image in the gallery.

Request:

GET /gallery/image/{id}
Authorization: {}

gallery-reporting

Report an Image in the gallery

Request:

POST /3/gallery/{id}/report
Authorization: {}

gallery-votes

Get the vote information about an image

Request:

GET /gallery/album/{id}/votes
Authorization: {}

gallery-voting

Vote for an image, up or down vote

Request:

POST /gallery/album/{id}/vote/{vote}
Authorization: {}

gallery-comments

Comment on an image in the gallery.

Request:

GET /gallery/album/{id}/comments
Authorization: {}

gallery-comment

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

Request:

GET /gallery/album/{id}/comment/{id}
Authorization: {}

gallery-comment-creation

Create a comment for an image.

Request:

POST /gallery/album/{id}/comment
    ?comment={}
Authorization: {}

Parameters

Key	Required	Value
comment	required	The text of the comment.

gallery-comment-reply

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

Request:

POST /gallery/album/{id}/comment/{id}
    ?comment={}
Authorization: {}

Parameters

Key	Required	Value
comment	required	The text you want to use as the reply.

gallery-comment-ids

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

Request:

GET /gallery/album/{id}/comments/ids
Authorization: {}

gallery-comment-count

The number of comments on an Image.

Request:

GET /gallery/album/{id}/comments/count
Authorization: {}

image

Get information about an image.

Request:

GET /image/{id}
Authorization: {}

image-delete

Delete an image with the deletehash that is returned to image owners.

Request:

DELETE /image/{deletehash}
Authorization: {}

image-upload

Upload a new image.

Request:

POST /image
    ?image={}
    &[album_id={}]
    &[type={}]
    &[name={}]
    &[title={}]
    &[description={}]
Authorization: {}

Parameters:

Key	Required	Description
image	required	A binary file, base64 data, or a URL for an image
album_id	optional	The id of the album you want to add the image to
type	optional	The type of the file that's being sent; file, base64 or URL
name	optional	The name of the file, this is automatically detected if uploading a file with a POST and multipart / form-data
title	optional	The title of the image.
description	optional	The description of the image.

image-update

Updates the title or description of an image. You can only update an image you own and is associated with your account.

Request:

PUT /image/{id}
    ?[title={}]
    &[description={}]
Authorization: {}

Parameters

Key	Required	Description
title	optional	The title of the image.
description	optional	The description of the image.

messages

Get one message from every thread the user has received. For example if a user has 5 messages, but 3 of them are on the same thread there will be 3 messages returned.

Request:

GET /messages
Authorization: {}

messages-ids

Returns an array of the message ids, this also limited and is paged.

Request:

GET /messages/ids/{page}
Authorization: {}

messages-count

Return the total count of messages for the user.

Request:

GET /messages/count
Authorization: {}

message

Get information about a specific message

Request:

get /message/{id}
Authorization: {}

message-thread

Get a specific message and the rest of the conversation with that message. The message ID sent needs to be the parent id. This is the same id as the first message in the thread.

Request:

GET /message/{id}/thread
Authorization: {}

message-create

Create a new message.

Request:

POST /message
    ?recipient={}
    &body={}
    &[subject={}]
    &[parent_id={}]
Authorization: {}

Parameters

Key	Required	Description
recipient	required	The recipient username, this person will receive the message
body	required	The message itself, similar to the body of an email.
subject	optional	The subject of the message, this is not required
parent_id	optional	If this message is in reply to another message set the parent_id to message id of the initial message.

message-delete

Delete a message by the given ID.

Request:

DELETE /message/{id}
Authorization: {}

message-report

Report a user for sending messages that are against the Terms of Service.

Request:

POST /message/report/{username}
Authorization: {}

message-block

Block the user from sending messages to the user that is logged in.

Request:

POST /message/block/{username}
Authorization: {}

notifications

Get all notifications for the user that's currently logged in.

Request:

GET /notification
    ?[new={}]
Authorization: {}

Parameters

Key	Required	Value
new	optional	boolean - false for all notifications, true for only non-viewed notification. Default is true.

notification

Returns the data about a specific notification

Request:

GET /notification/{id}
Authorization: {}

notification-viewed

Marks a notification as viewed, this way it no longer shows up in the basic notification request.

Request:

PUT /notification/{id}
Authorization: {}

credits

Check your rate limits.

Request:

GET /credits
Authorization: {}

Files

imgur.v3.md

Latest commit

History

imgur.v3.md

File metadata and controls

imgur

Authorization header

Current Account

account

Request:

account-create

Request:

account-delete

Request:

account-likes

Reqest:

account-submissions

Request:

account-settings

Request:

account-stats

Request:

account-profile

Request:

account-albums

Request:

Parameters

account-get-album

Request:

album-ids

Request:

album-count

Request:

account-album-delete

Request:

comments

Request:

comment

Request:

comment-ids

Request:

comment-count

Request:

account-comment-delete

Request:

images

Request:

account-image

Request:

image-ids

Request:

image-count

Request:

account-image-delete

Request:

account-notifications

Request:

Parameters

account-messages

Request:

Parameters

messages-send

Request:

Parameters

replies

Request:

Parameters

album-get

Request:

album-images

Request:

album-image

Request:

album-upload

Request:

Parameters

album-update

Request:

Parameters