Commercial Imgur API

Documentation

The full documentation is available on http://api.imgur.com

Support

For questions, please refer to the Google Group located at https://groups.google.com/forum/?fromgroups#!forum/imgur or email support@imgur.com

Last 7 days, UTC

Average Latency
9ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time

Simple & Straightforward Pricing

Pay as you go. No long-term contracts.

Freemium

$0

additional fees may apply

Requests

12,500 / day

$0.0001 per extra

Uploads

1,250 / day

$0.0010 per extra

Subscribe

premium

$100.00

per month

Requests

1,000,000 / day

$0.0001 per extra

Uploads

100,000 / day

$0.0010 per extra

Subscribe

ultra

$500.00

per month

Requests

5,000,000 / day

$0.0001 per extra

Uploads

500,000 / day

$0.0010 per extra

Subscribe
Header Authentication
 

OAuth 2.0


Authentication
Description
Parameter
String

The OAuth 2.0 Authorization Header. Requires Bearer :token

Authorization

Required

Account

HTTP 200 : Account GET/3/account/{username}
information about an account
						{
    "data" : {
    {
        "id" : 579342,
        "url" : "joshTest",
        "bio" : "A real hoopy frood who really knows where his towel is at."
        "reputation" : 15303.84
    },
    "status" : 200,
    "success" : true
}						
Account

Request standard user information.


Test console
Description
Parameter
string

username

Required

HTTP 200 : Basic GET/3/account/{username}/albums/count
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Account Album Count

The number of albums an account contains


Test console
Description
Parameter
string

username

Required

HTTP 200 : Basic DELETE/3/account/{username}/album/{id}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Account Album Deletion

Delete an account album


Test console
Description
Parameter
string

username

Required

string

id

Required

HTTP 200 : Basic GET/3/account/{username}/albums/ids
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Account Album Ids

Get all of the ids for all of the albums associated with the account


Test console
Description
Parameter
string

username

Required

HTTP 200 : Album GET/3/account/{username}/album/{id}
The standard layout for an album
						{
  "data": {
    "id": "DMQBe",
    "title": "Created By API",
    "description": null,
    "privacy": "public",
    "cover": "d7z2x",
    "order": 0,
    "layout": "blog",
    "datetime": 1347058832,
    "link": "http://imgur.com/a/DMQBe"
  },
  "success": true,
  "status": 200
}						
Account Album Information

Get More information about a specific album


Test console
Description
Parameter
string

username

Required

string

id

Required

HTTP 200 : Album GET/3/account/{username}/albums
The standard layout for an album
						{
  "data": {
    "id": "DMQBe",
    "title": "Created By API",
    "description": null,
    "privacy": "public",
    "cover": "d7z2x",
    "order": 0,
    "layout": "blog",
    "datetime": 1347058832,
    "link": "http://imgur.com/a/DMQBe"
  },
  "success": true,
  "status": 200
}						
Account Albums

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


Test console
Description
Parameter
string

username

Required

number

Allows you to set the page number so you don't have to retrieve all the data at once.
Example: 0

page

Optional

HTTP 200 : string POST/3/account/{username}
Account Creation

You must send recaptcha information with this request. Use this as the public captcha key: 6Lf7R8USAAAAAIkTcbhc8Di49orfHUuExshF9z8I


Test console
Description
Parameter
string

Username of the account
Example: ilikemuffins

username

Required

HTTP 200 : Basic DELETE/3/account/{username}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Account Deletion

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


Test console
Description
Parameter
string

Username of the account
Example: ilikemuffins

username

Required

HTTP 200 : Image GET/3/account/{username}/image/{id}
The standard Image Model
						{
  "data": {
    "id": "SbBGk",
    "title": "new title 1",
    "description": "it worked!",
    "datetime": 1341533193,
    "type": "image/jpeg",
    "animated": "false",
    "width": 2559,
    "height": 1439,
    "size": 521916,
    "views": 1,
    "bandwidth": 521916,
    "deletehash": "eY0ERNNJHsbreDa"
  },
  "success": true,
  "status": 200
}						
Account Image Information

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.


Test console
Description
Parameter
string

username

Required

string

id

Required

HTTP 200 : Image GET/3/account/{username}/images/{page}
The standard Image Model
						{
  "data": {
    "id": "SbBGk",
    "title": "new title 1",
    "description": "it worked!",
    "datetime": 1341533193,
    "type": "image/jpeg",
    "animated": "false",
    "width": 2559,
    "height": 1439,
    "size": 521916,
    "views": 1,
    "bandwidth": 521916,
    "deletehash": "eY0ERNNJHsbreDa"
  },
  "success": true,
  "status": 200
}						
Account Images

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


Test console
Description
Parameter
string

username

Required

string

page

Required

HTTP 200 : Basic GET/3/account/{username}/images/count
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Account Images Count

Returns the total number of images associated with the account.


Test console
Description
Parameter
string

username

Required

HTTP 200 : Basic GET/3/account/{username}/images/ids
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Account Images Ids

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


Test console
Description
Parameter
string

username

Required

HTTP 200 : Image GET/3/account/{username}/likes
The standard Image Model
						{
  "data": {
    "id": "SbBGk",
    "title": "new title 1",
    "description": "it worked!",
    "datetime": 1341533193,
    "type": "image/jpeg",
    "animated": "false",
    "width": 2559,
    "height": 1439,
    "size": 521916,
    "views": 1,
    "bandwidth": 521916,
    "deletehash": "eY0ERNNJHsbreDa"
  },
  "success": true,
  "status": 200
}						
Account Likes

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


Test console
Description
Parameter
string

username

Required

HTTP 200 : string GET/3/account/{username}/notifications/messages
Account Messages

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


Test console
Description
Parameter
string

username

Required

string

false for all notifications, true for only non-viewed notification. Default is true.
Example: true

new

Optional

HTTP 200 : string POST/3/account/{username}/message
Account Send Message

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.


Test console
Description
Parameter
string

username

Required

string

The text of the message. Similar to the body of an email.

body

Required

string

The subject of the message

subject

Optional

string

The ID of the first message in the thread, by setting this, the message will be threaded to the given message.

parent_id

Optional

HTTP 200 : Account Settings GET/3/account/{user}/settings
the basic account settings
						{
  "data": {
    "email": "josh@imgur.com",
    "high_quality": true,
    "public_images": false,
    "album_privacy": false,
    "pro_expiration": null,
    "active_emails": [],
    "messaging_enabled": true,
    "blocked_users": []
  },
  "success": true,
  "status": 200
}						
Account Settings

Get the account settings if you're logged in as the user


Test console
Description
Parameter
string

user

Required

HTTP 200 : Account Statistics GET/3/account/{username}/stats
The account statistic information, expanded data set from the basic account
						{
  "data" : {
    "total_images" : 10,
    "captions" : [],
    "popular_images" : [],
    "popular_albums" : [],
    "disk_used" : "8.92 MB",
    "bandwidth_used" : "5.73 GB"
  }
  "success" : true,
  "status" : 200
}						
Account Statistics

Return the statistics about the account.


Test console
Description
Parameter
string

username

Required

HTTP 200 : Basic DELETE/3/account/{username}/image/{id}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Delete Account Image

Delete an image that belongs to the logged in user


Test console
Description
Parameter
string

username

Required

string

id

Required

HTTP 200 : Basic POST/3/account/{username}/settings
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Update Account Settings

Change the account settings


Test console
Description
Parameter
string

Change the users email
Example: josh@imgur.com

email

Optional

number

Use 0 or 1 for the boolean value
Example: 0

public_images

Optional

number

Use 0 or 1 for the boolean value
Example: 0

album_privacy

Optional

string

Use 0 or 1 for the boolean value
Example: 0

messaging_enabled

Optional

string

username

Required

Album

HTTP 200 : Basic POST/3/album/{id}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Add Album Images

Add more images to the album.


Test console
Description
Parameter
string

IDs of images to be added to the album, can be sent as array with multiple images
Example: UdJ7r

ids[]

Required

string

id

Required

HTTP 200 : Album GET/3/album/{id}
The standard layout for an album
						{
  "data": {
    "id": "DMQBe",
    "title": "Created By API",
    "description": null,
    "privacy": "public",
    "cover": "d7z2x",
    "order": 0,
    "layout": "blog",
    "datetime": 1347058832,
    "link": "http://imgur.com/a/DMQBe"
  },
  "success": true,
  "status": 200
}						
Album

Get album information


Test console
Description
Parameter
string

id

Required

HTTP 200 : Image GET/3/album/{album_id}/image/{image_id}
The standard Image Model
						{
  "data": {
    "id": "SbBGk",
    "title": "new title 1",
    "description": "it worked!",
    "datetime": 1341533193,
    "type": "image/jpeg",
    "animated": "false",
    "width": 2559,
    "height": 1439,
    "size": 521916,
    "views": 1,
    "bandwidth": 521916,
    "deletehash": "eY0ERNNJHsbreDa"
  },
  "success": true,
  "status": 200
}						
Album Image

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


Test console
Description
Parameter
string

The 5 character string for the album id
Example: j3sjd

album_id

Required

string

The id of 5 characters for the image
Example: ah3ds

image_id

Required

HTTP 200 : Album GET/3/album/{id}/images
The standard layout for an album
						{
  "data": {
    "id": "DMQBe",
    "title": "Created By API",
    "description": null,
    "privacy": "public",
    "cover": "d7z2x",
    "order": 0,
    "layout": "blog",
    "datetime": 1347058832,
    "link": "http://imgur.com/a/DMQBe"
  },
  "success": true,
  "status": 200
}						
Album Images

Return all of the images in the album


Test console
Description
Parameter
string

id

Required

HTTP 200 : Basic POST/3/album
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Album Upload

This is how you upload an album


Test console
Description
Parameter
string

The images you want to include in the album
Example: kLKA6

ids[]

Optional

HTTP 200 : Basic DELETE/3/album/{id}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Album delete

This deletes an album, the user must be logged in to do this


Test console
Description
Parameter
string

id

Required

Comment

HTTP 200 : string DELETE/3/account/{username}/comment/{id}
Account Comment Deletion

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


Test console
Description
Parameter
string

username

Required

string

id

Required

HTTP 200 : Comment GET/3/account/{username}/comments
The model of comments
						{
    "data" : {
        "id": 2320,
        "image_id": "FKWF5",
        "caption": "This comment is for an image, it's a pretty awesome image.",
        "author": "joshTest",
        "author_id": 579342,
        "ups": 1,
        "downs": 0,
        "points": 1,
        "datetime": 1348088207,
        "parent_id": null,
        "deleted": false,
        "children": [ … ]
     },
     "success" : true,
     "status" : 200
}						
Account Comments

The comments that the user has made


Test console
Description
Parameter
string

username

Required

HTTP 200 : Comment GET/3/comment/{id}
The model of comments
						{
    "data" : {
        "id": 2320,
        "image_id": "FKWF5",
        "caption": "This comment is for an image, it's a pretty awesome image.",
        "author": "joshTest",
        "author_id": 579342,
        "ups": 1,
        "downs": 0,
        "points": 1,
        "datetime": 1348088207,
        "parent_id": null,
        "deleted": false,
        "children": [ … ]
     },
     "success" : true,
     "status" : 200
}						
Comment

Get comment information


Test console
Description
Parameter
string

id

Required

HTTP 200 : string GET/3/account/{username}/comments/count
Comment Count

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


Test console
Description
Parameter
string

username

Required

HTTP 200 : Basic DELETE/3/comment/{id}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Comment Delete

Delete a comment, will be marked as deleted if there are any replies


Test console
Description
Parameter
string

id

Required

HTTP 200 : string GET/3/account/{username}/comments/ids
Comment IDs

Return an array of all of the comment IDs.


Test console
Description
Parameter
string

username

Required

HTTP 200 : Comment GET/3/comment/{id}/replies
The model of comments
						{
    "data" : {
        "id": 2320,
        "image_id": "FKWF5",
        "caption": "This comment is for an image, it's a pretty awesome image.",
        "author": "joshTest",
        "author_id": 579342,
        "ups": 1,
        "downs": 0,
        "points": 1,
        "datetime": 1348088207,
        "parent_id": null,
        "deleted": false,
        "children": [ … ]
     },
     "success" : true,
     "status" : 200
}						
Comment Replies

View the comment and the thread of replies


Test console
Description
Parameter
string

id

Required

HTTP 200 : Basic POST/3/comment/{id}/vote/{vote}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Comment Vote

Vote for a comment, :vote is up or down


Test console
Description
Parameter
string

id

Required

string

vote

Required

HTTP 200 : Basic POST/3/comment/{id}/report
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Report Comment

Report a comment for being vulgar


Test console
Description
Parameter
string

ID of the comment

id

Required

Gallery

HTTP 200 : Gallery Image GET/3/gallery/r/{subreddit}/{sort}/{page}
The image format returned from all gallery requests
						{
  "data": {
    "id": "HiSsA",
    "title": "Texas Children's Hospital : you're awesome!!!",
    "datetime": 1348101011,
    "type": "image/jpeg",
    "animated": "false",
    "width": 660,
    "height": 462,
    "size": 52437,
    "views": 0,
    "bandwidth": 0,
    "ups": 248,
    "downs": 5,
    "score": 2430000
  },
  "success": true,
  "status": 200
}						
Subreddit Galleries

View the gallery information for a specific subreddit, sorts are: hot, top, and new.


Test console
Description
Parameter
string

the subreddit
Example: pics

subreddit

Required

string

the sort

sort

Required

string

the page number
Example: 0

page

Required

Image

HTTP 200 : Image GET/3/image/{id}
The standard Image Model
						{
  "data": {
    "id": "SbBGk",
    "title": "new title 1",
    "description": "it worked!",
    "datetime": 1341533193,
    "type": "image/jpeg",
    "animated": "false",
    "width": 2559,
    "height": 1439,
    "size": 521916,
    "views": 1,
    "bandwidth": 521916,
    "deletehash": "eY0ERNNJHsbreDa"
  },
  "success": true,
  "status": 200
}						
Image

Get information about an image


Test console
Description
Parameter
string

id

Required

HTTP 200 : string DELETE/3/image/{deletehash}
Image Delete

Test console
Description
Parameter
string

Deletehash of an image
Example: 123456789123456

deletehash

Required

HTTP 200 : Basic POST/3/image
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Image Upload

Upload an image


Test console
Description
Parameter
string

The binary data, a url string, or base64 data

image

Required

string

ID of the album to upload to

album_id

Optional

string

The type of image being uploaded : binary, url, base64

type

Optional

string

A title for the image

title

Optional

string

A description of the image

description

Optional

HTTP 200 : Basic POST/3/upload
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Image Upload Alternative

This is another way to upload images


Test console
Description
Parameter
string

A binary file, base64 data, or a URL for an image

image

Required

string

The id of the album you want to add the image to

album_id

Optional

string

The type of the file that's being sent; file, base64 or URL

type

Required

string

The name of the file, this is automatically detected if uploading a file with a POST and multipart / form-data

name

Required

string

The title of the image.

title

Required

string

The description of the image.

description

Required

Notification

HTTP 200 : Notification GET/3/account/{username}/notifications/{type}
This is what a basic notification looks like
						{
  "data": {
    "replies": {
      "id": 4511,
      "account_id": 579342,
      "viewed": false,
      "content": {}
    },
    "messages": {
      "id": 4512,
      "account_id": 579342,
      "viewed": false,
      "content": {}
    }
  },
  "success": true,
  "status": 200
}						
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.


Test console
Description
Parameter
string

username

Required

string

type

Required

HTTP 200 : Notification GET/3/notification/{id}
This is what a basic notification looks like
						{
  "data": {
    "replies": {
      "id": 4511,
      "account_id": 579342,
      "viewed": false,
      "content": {}
    },
    "messages": {
      "id": 4512,
      "account_id": 579342,
      "viewed": false,
      "content": {}
    }
  },
  "success": true,
  "status": 200
}						
Notification

Returns data about a specific notification


Test console
Description
Parameter
string

id

Required

HTTP 200 : Basic DELETE/3/notification/{id}
This model is returned if it's a POST, PUT, or DELETE request.
						{
    'data' : null,
    'success' : true,
    'status' : 200
}						
Notification Viewed

Mark a notification as viewed. This will stop the notification from showing up in the standard requests. Also works as PUT or DELETE request


Test console
Description
Parameter
string

The ID of the notification

id

Required

HTTP 200 : Notification GET/3/notification
This is what a basic notification looks like
						{
  "data": {
    "replies": {
      "id": 4511,
      "account_id": 579342,
      "viewed": false,
      "content": {}
    },
    "messages": {
      "id": 4512,
      "account_id": 579342,
      "viewed": false,
      "content": {}
    }
  },
  "success": true,
  "status": 200
}						
Notifications

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


You must have an API key to test this API!


Mashape allows developers to find, consume, and distribute cloud APIs just like Imgur.

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.