NAME
Imgur::API::Endpoint::Account
DESCRIPTION
Access to the imgur Account API Endpoint.
METHODS
get
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 account ID. To do so, pass the query parameter account_id.
Parameters
username
requiredUsername
galleryFavorites
Return the images the user has favorited in the gallery.
Parameters
username
requiredUsername
page
optionalinteger - allows you to set the page number so you don't have to retrieve all the data at once.
sort
optional'oldest', or 'newest'. Defaults to 'newest'.
favorites
Returns the users favorited images, only accessible if you're logged in as the user.
Parameters
username
requiredUsername
page
optionalinteger - allows you to set the page number so you don't have to retrieve all the data at once.
sort
optional'oldest', or 'newest'. Defaults to 'newest'.
submissions
Return the images a user has submitted to the gallery
Parameters
username
requiredUsername
page
requiredPage
settings
Returns the account settings, only accessible if you're logged in as the user.
Parameters
username
requiredUsername
updateSettings
Updates the account settings for a given user, the user must be logged in.
Parameters
messaging_enabled
optionaltrue | false - Allows the user to enable / disable private messages
username
optionalA valid Imgur username (between 4 and 63 alphanumeric characters)
show_mature
optionaltrue | false - Toggle display of mature images in gallery list endpoints.
album_privacy
optionalpublic | hidden | secret - Sets the default privacy level of albums the users creates
accepted_gallery_terms
optionaltrue | false - The user agreement to the Imgur Gallery terms.
public_images
optionalSet the users images to private or public by default
newsletter_subscribed
optionaltrue | false - Toggle subscription to email newsletter.
bio
optionalThe biography of the user, is displayed in the gallery profile page.
profile
Returns the totals for the gallery profile.
Parameters
username
requiredUsername
verifyEmail
Checks to see if user has verified their email address
Parameters
username
requiredUsername
sendVerifyEmail
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.
Parameters
username
requiredUsername
albums
Get all the albums associated with the account. Must be logged in as the user to see secret and hidden albums.
Parameters
page
optionalinteger - allows you to set the page number so you don't have to retrieve all the data at once.
username
requiredUsername
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.
Parameters
account
requiredAccount
username
requiredUsername
albumIds
Return an array of all of the album IDs.
Parameters
page
optionalinteger - allows you to set the page number so you don't have to retrieve all the data at once.
username
requiredUsername
albumCount
Return the total number of albums associated with the account.
Parameters
username
requiredUsername
albumDelete
Delete an Album with a given id.
Parameters
username
requiredUsername
account
requiredAccount
comments
Return the comments the user has created.
Parameters
sort
optional'best', 'worst', 'oldest', or 'newest'. Defaults to 'newest'.
page
optionalPage number (50 items per page). Defaults to 0.
username
requiredUsername
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.
Parameters
account
requiredAccount
username
requiredUsername
commentIds
Return an array of all of the comment IDs.
Parameters
sort
optional'best', 'worst', 'oldest', or 'newest'. Defaults to 'newest'.
page
optionalPage number (50 items per page). Defaults to 0.
username
requiredUsername
commentCount
Return a count of all of the comments associated with the account.
Parameters
username
requiredUsername
commentDelete
Delete a comment. You are required to be logged in as the user whom created the comment.
Parameters
username
requiredUsername
account
requiredAccount
images
Return all of the images associated with the account. You can page through the images by setting the page, this defaults to 0.
Parameters
page
requiredPage
username
requiredUsername
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.
Parameters
username
requiredUsername
account
requiredAccount
imageIds
Returns an array of Image IDs that are associated with the account.
Parameters
page
optionalinteger - allows you to set the page number so you don't have to retrieve all the data at once.
username
requiredUsername
imageCount
Returns the total number of images associated with the account.
Parameters
username
requiredUsername
imageDelete
Deletes an Image. This requires a delete hash rather than an ID.
Parameters
username
requiredUsername
deletehash
requiredDeletehash
replies
Returns all of the reply notifications for the user. Required to be logged in as that user
Parameters
new
optionalboolean - false for all notifications, true for only non-viewed notification. Default is true.
username
requiredUsername
SEE ALSO
https://api.imgur.com/endpoints/account