Imageshack API

ImageShack SDK for Android: https://github.com/imageshack/imageshack-android-sdk

General Information

API Key

Authentication

Pagination

Error Handling

Response Models

User Model

User Usage Model

Login Model

User Settings Model

Subscription Model

Image Model

Basic Image Model

Images List Model

Upload Model

Album Model

Basic Album Model

Albums List Model

Tag Model

Tags List Model

Image Comment Model

Image Comments List Model

Message Model

Message Permissions Model

Bulk Model

File Model

Files List Model

Followers Images Model

Endpoints

User API

Get User

Create User

Update User

Delete User

Get User Usage

Get User Settings

Update User Settings

Get User Images

Get Random User Images

Get user albums

Get user tags

Search User Tags

Image API

Upload image

Transload image

Get Image

Get Multiple Images

Update Image

Update Multiple Images

Delete Image

Delete bulk Images

Get image likes

Like image

Unlike image

Get Related images

Get Image tags

Tag Image

Tag Images

Delete Image Tags

Delete Images Tags

Album API

Create Album

Get Album

      Get Multiple Albums

Update Album

Update Multiple Albums

Set album Images

Add Images to Album

Delete Images from Album

Delete Album

Delete Multiple Albums

Tags API

Search Site Images by Tags

Comments API

Get Comments

Add Comment

Delete Comment

Follow API

Follow User

Unfollower User

                  Get Followers

Get Followings

Get Followers Images

Get Following Images

Search API

Search Sitewide Images

Search Specific User

General Information

The Imageshack API is a RESTful API which uses HTTP requests and JSON responses.

This API is still in development; however, it is mostly completed and going forward all modifications will be backwards compatible. Please report any issues to is-support@imageshack.us

API Key

All non GET requests to the api require a Imageshack api key. You may request one from here:

http://imageshack.us/api_request/

Send the api key as a param to all requests

“api_key=<key>”

Authentication

Provide a username or email and password. The api will respond with an auth_token. Pass the  auth_token as a param to each API to access private data.

Imageshack Login

Route

https://api.imageshack.com/v2/user/login

Method

POST

Response

login Model

Params

Key

Required

Value

user

string

The username or email of the user logging in

password

string

The corresponding password to the user

auth_token

string

user and password may be substituted by auth_token

set_cookies

boolean

 When TRUE auth cookies will be set in the user's browser. Allowing the user to use imageshack

remember_me

boolean

 When TRUE and used with set_cookies the cookies will expire in 365 days instead of after session close.

Pagination

Many of the API endpoints support pagination. By default the responses will be limited at 20. Imageshack uses the limit and offset system. To increase number of records set the limit param. Use the offset param to pull different pages. For example:

Page 1

limit=20 offset=0

Page 2

limit=20 offset=20

page 3

limit=20 offset=40

Error Handling

When an error occurs an error Model will be displayed and the success flag will be false.

Json Example

{
 
"error":{
     
"error_code":3,
     
"error_message":"The username is invalid"
  }
}

Error codes

Response Models

User Model

Contains user properties and settings

key

Format

Description

is_owner

boolean

States if auth_token and username match

cache_version

integer

Current user version. Every account activity increments this number

user_id

integer

Internal persistent unique identifier for the user. Only shown when user is owner.

email

string

User’s email address. Only shown when user is owner.

username

string

The username of the user

description

string

The user’s bio

creation_date

integer

The creation date/time as a unix timestamp

location

string

The user’s location

first_name

string

The user’s first name

last_name

string

The user’s last name

Avatar->id

string

Unique alphanumeric image id of the user’s avatar image

Avatar->server

integer

The server location of the user’s avatar image

Avatar->filename

string

The filename of the user’s Avatar

membership

string

The user’s membership. “Pro”, “premium”, or “free”

is_following

boolean

True if user is being followed by the caller. requires authentication.

following_allowed

boolean

True if use allows following

latest_images

array of images

the last 5 images uploaded by the user

Json example

{

   "success":true,

   "process_time":137,

   "result":{

      "is_owner":false,

      "cache_version":32,

      "userid":null,

      "email":null,

      "username":"photohackday",

      "description":"Hello, my name is Nick",

      "creation_date":1365146199,

      "location":"Los Gatos, CA",

      "gender":"male",

      "first_name":"Nick",

      "last_name":"Dude",

      "avatar":{

         "id":"5slogolightcropp",

         "server":208,

         "filename":"logolightcrop.png"

      },

      "membership":"free",

      "is_following":false,

      "following_allowed":true,

      "latest_images":[

         {

            "id":"11img0317hJ",

            "server":37,

            "filename":"img0317h.JPG"

         },

         {

            "id":"0himg0319gqj",

            "server":17,

            "filename":"img0319gq.jpg"

         },

         {

            "id":"04img0320dmj",

            "server":4,

            "filename":"img0320dm.jpg"

         },

         {

            "id":"5slogolightcropp",

            "server":208,

            "filename":"logolightcrop.png"

         },

         {

            "id":"jaimg0318lj",

            "server":694,

            "filename":"img0318l.jpg"

         }

      ]

   }

}

User Usage Model

Key

Format

Description

images_count

integer

The total number of images in the account

album_images_count

integer

The total number of images in albums in account

root_images_count

integer

The number of images not part of an album

space_limit

integer

User storage limit in kilobytes (5 gigs for free accounts)

space_used

integer

Total space used in kilobytes

Json Example

{
 
"images_count":5,
 
"album_images_count":3,
 
"albums_count":1,
 
"root_images_count":2,
 
"space_limit":5242880,
 
"space_used":4682
}

Login Model

Contains authentication information.

Key

Format

Description

auth_token

string

The authorization token

user_id

integer

Internal persistent unique identifier for the user

email

string

Email address of the user

username

string

The username

Avatar->id

integer

Unique alphanumeric image id of the user’s avatar image.

Avatar->server

integer

The server location of the user’s avatar

Avatar->filename

string

The filename of the user’s Avatar

membership

string

The membership status.

membership_item_number

string

The membership item number. For pro accounts.

membership_cookie

string

The membership cookie. For pro accounts.

Json Example

{
 
"auth_token":"4fee7be36734d44eb7583c5dd61e6dbb",
 
"user_id":70501656,

   "email":"fakeemail@imageshack.us",
 
"username":"photohackday",
 
"avatar":{
     
"id":"5slogolightcropp",
     
"server":90,
     
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
  },

   "membership":"free",
 
"membership_item_number":null,
 
"membership_cookie":null
}

User Settings Model

Key

Format

Description

private_profile

boolean

If true the user’s public pages will not be available for viewing

private_images

boolean

If true user images will be set to non-public by default during upload

private_albums

boolean

If true user albums will be set to non-public by default during upload

private_files

boolean

If true user files will be set to non-public by default during upload

private_followings

boolean

If true user will not be able to be followed

upload_notification

boolean

If true user will receive a notification for each upload

comments_notification

boolean

If true user will receive a notification for comments on their images

shares_notification

boolean

If true user will receive a notification when someone shares their image

likes_notification

boolean

If true user will receive a notification when someone likes one of their images

follows_notification

boolean

If true user will receive a notification when someone follows them

new_feature_notification

boolean

If true user will receive a notification for new site features

weekly_update_notification

boolean

If true user will receive a weekly email report with all their uploads

daily_update_notification

boolean

If true user will receive a daily email report with all their uploads

skypath_message

boolean

If true user will receive a notification for skypath messages

skypath_share_file

boolean

If true user will receive a notification for skypath shared images

onboarding

boolean

true if the user has been through onboarding

Json Example:

{
 
"private_profile":true,
 
"private_images":false,
 
"private_albums":true,
 
"private_files":false,

   "private_followings":false,
 
"upload_notification":false,
 
"comments_notification":true,
 
"shares_notification":false,
 
"likes_notification":true,
 
"follows_notification":false,
 
"new_feature_notification":true,
 
"weekly_update_notification":false,
 
"daily_update_notification":false,

   "skypath_message":false,

   "skypath_share_file":false,

   "onboarding":false

}

Image Model

Contains properties and web locations of the image.

Key

Format

Description

id

string

Unique alphanumeric image id

server

integer

Server location

bucket

integer

bucket directory

filename

string

The filename on the server

original_filename

string

The original filename sent from user

direct_link

string

Direct link to the file

title

string

User set title of the image

description

string

Image description

tags

string array

Array of user generated tags

liked

boolean

True if current authenticated user liked image

likes

integer

Number of likes the image has received

views

integer

Number of landing page views the image has received

moderated

boolean

true if the image has been moderated

album->id

string

Unique alphanumeric album id. Only displays if image is in an album

album->title

string

Album tile. Only displays if image is in an album

album->public

boolean

States whether the album is marked public. Only displays if image is in an album

comments_count

integer

Number of comments associated with image

comments_disabled

boolean

Specifies whether or not the image allows comments

filter

integer

User specified image filter 0-23. 0 is no filter

filesize

integer

file size in kilobytes

creation_date

integer

The creation date/time as a unix timestamp

width

integer

The width of the image

height

integer

the height of the image

public

boolean

States whether the image is marked public

is_owner

boolean

States if auth_token owns this image

owner->username

string

The username of the owner. Only displayed on images marked as public

owner->avatar->id

string

Unique alphanumeric image id. Only shown on images marked as public

owner->avatar->server

integer

Server location of the owner’s avatar. Only shown on images marked as public

owner->avatar->filename

string

Filename of the owner’s avatar. Only shown on images marked as public

next_images[]

array

Array of next images. default 2

previous_images[]

array

Array of previous images. default 2

related_images[]

array

An array of related images

Json Example:

{
 
"id":"04img0320dmj",
 
"server":4,
 
"bucket":3180,
 
"filename":"img0320dm.jpg",
 
"original_filename":"IMG_0320.JPG",
 
"direct_link":"imageshack.us\/a\/img4\/3180\/img0320dm.jpg",
 
"title":"Snowy Lake Tahoe 2011-2012",
 
"description":null,
 
"tags":[
     
"lake tahoe",
     
"winter",
     
"snow"
  ],
 
"likes":0,
 
"liked":false,
 
"views":6,

   "moderated":true,

   "album_id":"B02F",

   "album_title":"Tahoe Snow",
 
"comments_count":0,
 
"comments_disabled":false,
 
"filter":0,
 
"filesize":286,
 
"creation_date":1365147682,
 
"width":800,
 
"height":600,
 
"public":true,
 
"is_owner":false,
 
"owner":{
     
"username":"photohackday",
     
"avatar":{
       
"id":"5slogolightcropp",
       
"server":208,
       
"filename":"logolightcrop.png"
     }
  },
 
"next_images":[
     {
       
"id":"5slogolightcropp",
       
"server":208,
       
"filename":"logolightcrop.png"
     }
  ],
 
"prev_images":[
     {
       
"id":"0himg0319gqj",
       
"server":17,
       
"filename":"img0319gq.jpg"
     },
     {
       
"id":"jaimg0318lj",
       
"server":694,
       
"filename":"img0318l.jpg"
     }
  ],
 
"related_images":[
     {
       
"id":"66pc1600637baj",
       
"server":222,
       
"filename":"pc1600637ba.jpg"
     },
     {
       
"id":"25Porsche928GTSg",
       
"server":77,
       
"filename":"Porsche928GTS.gif"
     },
     {
       
"id":"66pc1600808gbj",
       
"server":222,
       
"filename":"pc1600808gb.jpg"
     },
     {
       
"id":"0pPorsche928GTS3g",
       
"server":25,
       
"filename":"Porsche928GTS3.gif"
     },
     {
       
"id":"6ipc1600648wqj",
       
"server":234,
       
"filename":"pc1600648wq.jpg"
     },
     {
       
"id":"53amwegrand7xkj",
       
"server":183,
       
"filename":"amwegrand7xk.jpg"
     },
     {
       
"id":"1uDrift2g",
       
"server":66,
       
"filename":"Drift2.gif"
     },
     {
       
"id":"6ipc1600798yej",
       
"server":234,
       
"filename":"pc1600798ye.jpg"
     },
     {
       
"id":"6f600abarthsnowdrift2ltg",
       
"server":231,
       
"filename":"600abarthsnowdrift2lt.gif"
     },
     {
       
"id":"6ipc1600670odj",
       
"server":234,
       
"filename":"pc1600670od.jpg"
     }
  ]
}

Basic Image Model

A minimal image model. Used for array of images.

Key

Format

Description

id

string

Unique alphanumeric image id

server

integer

Server location

bucket

integer

bucket directory

filename

string

The filename on the server

original_filename

string

The original filename sent from user

title

string

User generated image title

album_id

string

Unique alphanumeric album id. Only displays if image is in an album

album_title

string

Album tile. Only displays if image is in an album

creation_date

integer

The creation date/time as a unix timestamp

public

boolean

States whether the image is marked public

hidden

boolean

States whether the image has been deleted

filesize

integer

file size in kilobytes

width

integer

The width of the image

height

integer

the height of the image

owner->username

string

The username of the owner. Only displayed on images marked as public

owner->avatar->id

string

unique alphanumeric image id

owner->avatar->server

integer

Server location of the owner’s avatar. Only shown on images marked as public

owner->avatar->filename

string

Filename of the owner’s avatar. Only shown on images marked as public

Json example

{
 
"id":"04img0320dmj",
 
"server":4,
 
"bucket":3180,
 
"filename":"img0320dm.jpg",
 
"original_filename":"IMG_0320.JPG",
 
"title":"Snowy Lake Tahoe 2011-2012",
 
"creation_date":1365147682,
 
"public":true,
 
"hidden":false,
 
"filesize":286,
 
"width":800,
 
"height":600,
 
"is_owner":false,
 
"owner":{
     
"username":"photohackday",
     
"avatar":{
       
"id":"5slogolightcropp",
       
"server":208,
       
"filename":"logolightcrop.png"
     }
  }
}

Images List Model

Contains a list of basic image objects from user accounts

Key

Format

Description

base_url

string

Base of the direct links. Append server/bucket/filename to build the link

limit

integer

Number of images returned (pagination)

offset

integer

Number of images to offset (pagination)

total

integer

Total number of images in account

images

array

An array of Basic Image Models

Json example

{
 
"base_url":"imageshack.us\/a\/",
 
"limit":20,
 
"offset":0,
 
"total":5,
 
"images":[
     {
       
"id":"0himg0319gqj",
       
"server":17,
       
"bucket":4246,
       
"filename":"img0319gq.jpg",
       
"original_filename":"IMG_0319.JPG",
       
"title":null,
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":309,
       
"width":800,
       
"height":600,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     },
     {
       
"id":"04img0320dmj",
       
"server":4,
       
"bucket":3180,
       
"filename":"img0320dm.jpg",
       
"original_filename":"IMG_0320.JPG",
       
"title":"Snowy Lake Tahoe 2011-2012",
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":286,
       
"width":800,
       
"height":600,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     },
     {
       
"id":"5slogolightcropp",
       
"server":208,
       
"bucket":199,
       
"filename":"logolightcrop.png",
       
"original_filename":"logo_light_crop.png",
       
"title":null,
       
"creation_date":1365146498,
       
"public":true,
       
"hidden":false,
       
"filesize":10,
       
"width":70,
       
"height":61,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     },
     {
       
"id":"jaimg0318lj",
       
"server":694,
       
"bucket":1416,
       
"filename":"img0318l.jpg",
       
"original_filename":"IMG_0318.JPG",
       
"title":null,
       
"creation_date":1365146206,
       
"public":true,
       
"hidden":false,
       
"filesize":319,
       
"width":800,
       
"height":600,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     }
  ]
}

Upload Model

The model returned on upload or transload

Key

Format

Description

max_filesize

integer

The maximum filesize the current user is allowed in kilobytes

space_limit

integer

The maximum account storage limit in kilobytes

space_used

integer

The current storage used in kilobytes

space_left

integer

The difference from space_limit and space_used in kilobytes

passed

integer

The number of images uploaded successfully

failed

integer

The number of images upload failures.

images

array

An array of the Image Models successfully uploaded

Album Model

Contains properties and contents of the album.

Key

Format

Description

id

string

Unique alphanumeric album id

title

string

User set album title

description

string

User generated album description. 200 char limit.

creation_date

integer

The creation date/time as a unix timestamp

public

boolean

States whether the album is marked public

is_owner

boolean

States if auth_token owns this album

owner->username

string

Username of the owner of the album. Only shows if the album is marked public.

owner->avatar->id

string

Unique alphanumeric id of user’s avatar image

owner->avatar->server

integer

Server location of the owner’s avatar. Only shown on images marked as public

owner->avatar->filename

string

Filename of the owner’s avatar. Only shown on images marked as public

limit

integer

Number of images returned (pagination)

offset

integer

Number of images to offset (pagination)

total

integer

Total number of images in album

images[]

array of images

An array of Basic Image Models

Json Example:

{
 
"id":"B02F",
 
"title":"Tahoe Snow",
 
"description":null,
 
"creation_date":1365147682,
 
"public":true,
 
"is_owner":false,
 
"owner":{
     
"username":"photohackday",
     
"avatar":{
       
"id":"5slogolightcropp",
       
"server":208,
       
"filename":"logolightcrop.png"
     }
  },
 
"limit":20,
 
"offset":0,
 
"total":3,
 
"images":[
     {
       
"id":"11img0317hj",
       
"server":37,
       
"bucket":2295,
       
"filename":"img0317h.JPG",
       
"original_filename":"IMG_0317.JPG",
       
"title":null,
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":3758,
       
"width":600,
       
"height":800,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     },
     {
       
"id":"0himg0319gqj",
       
"server":17,
       
"bucket":4246,
       
"filename":"img0319gq.jpg",
       
"original_filename":"IMG_0319.JPG",
       
"title":null,
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":309,
       
"width":800,
       
"height":600,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     },
     {
       
"id":"04img0320dmj",
       
"server":4,
       
"bucket":3180,
       
"filename":"img0320dm.jpg",
       
"original_filename":"IMG_0320.JPG",
       
"title":"Snowy Lake Tahoe 2011-2012",
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":286,
       
"width":800,
       
"height":600,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     }
  ]
}

Basic Album Model

A minimal version of the album Model.

Key

Format

Description

id

string

Unique alphanumeric album id

title

string

User set album title

creation_date

integer

The creation date/time as a unix timestamp

public

boolean

States whether the album is marked public

total

integer

Total number of images in album

is_owner

boolean

States if auth_token owns this album

owner->username

string

Username of the owner of the album. Only shows if the album is marked public.

owner->avatar->id

string

Unique alphanumeric id of user’s avatar image

owner->avatar->server

integer

Server location of the owner’s avatar. Only shown on images marked as public

owner->avatar->filename

string

Filename of the owner’s avatar. Only shown on images marked as public

images[]

array of images

An array of Basic Image Models

Json Example

{
 
"id":"B02F",
 
"title":"Tahoe Snow",
 
"creation_date":1365147682,
 
"public":true,
 
"is_owner":false,
 
"owner":{
     
"username":"photohackday",
     
"avatar":{
       
"id":"5slogolightcropp",
       
"server":208,
       
"filename":"logolightcrop.png"
     }
  },
 
"total":3,
 
"images":[
     {
       
"id":"11img0317hj",
       
"server":37,
       
"bucket":2295,
       
"filename":"img0317h.JPG",
       
"original_filename":"IMG_0317.JPG",
       
"title":null,
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":3758,
       
"width":0,
       
"height":0,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     },
     {
       
"id":"0himg0319gqj",
       
"server":17,
       
"bucket":4246,
       
"filename":"img0319gq.jpg",
       
"original_filename":"IMG_0319.JPG",
       
"title":null,
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":309,
       
"width":800,
       
"height":600,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     },
     {
       
"id":"04img0320dmj",
       
"server":4,
       
"bucket":3180,
       
"filename":"img0320dm.jpg",
       
"original_filename":"IMG_0320.JPG",
       
"title":"Snowy Lake Tahoe 2011-2012",
       
"creation_date":1365147682,
       
"public":true,
       
"hidden":false,
       
"filesize":286,
       
"width":800,
       
"height":600,
       
"is_owner":false,
       
"owner":{
           
"username":"photohackday",
           
"avatar":{
             
"id":"5slogolightcropp",
             
"server":208,
             
"filename":"logolightcrop.png"
           }
        }
     }
  ]
}

Albums List Model

Contains a list of albums from a user account

Key

Format

Description

limit

integer

Number of albums returned (pagination)

offset

integer

Number of albums to offset (pagination)

total

integer

Total number of albums in account

albums

array

An array of Basic Album Models

Json Example

{
 
"limit":3,
 
"offset":0,
 
"total":48,
 
"albums":[
     {
       
"id":"QIqF",
       
"title":"new alll",
       
"creation_date":1370372168,
       
"public":true,
       
"is_owner":false,
       
"owner":{
           
"username":"nicktest70",
           
"avatar":{
             
"id":"0wbobrosshappylittlecloudj",
             
"server":32,
             
"filename":"bobrosshappylittlecloud.jpg"
           }
        },
       
"total":0,
       
"images":null
     },
     {
       
"id":"dLNQ",
       
"title":"Scenes from Havana",
       
"creation_date":1360114735,
       
"public":true,
       
"is_owner":false,
       
"owner":{
           
"username":"nicktest70",
           
"avatar":{
             
"id":"0wbobrosshappylittlecloudj",
             
"server":32,
             
"filename":"bobrosshappylittlecloud.jpg"
           }
        },
       
"total":6,
       
"images":[
           {
             
"id":"nrc0119868015j",
             
"server":855,
             
"bucket":8596,
             
"filename":"c0119868015.jpg",
             
"original_filename":"c01_19868015.jpeg",
             
"title":null,
             
"creation_date":1360114749,
             
"public":true,
             
"hidden":false,
             
"filesize":147,
             
"width":990,
             
"height":651,
             
"is_owner":false,
             
"owner":{
                 
"username":"nicktest70",
                 
"avatar":{
                   
"id":"0wbobrosshappylittlecloudj",
                   
"server":32,
                   
"filename":"bobrosshappylittlecloud.jpg"
                 }
              }
           },
           {
             
"id":"myc0211937677j",
             
"server":826,
             
"bucket":7168,
             
"filename":"c0211937677.jpg",
             
"original_filename":"c02_11937677.jpeg",
             
"title":null,
             
"creation_date":1360114750,
             
"public":true,
             
"hidden":false,
             
"filesize":313,
             
"width":990,
             
"height":639,
             
"is_owner":false,
             
"owner":{
                 
"username":"nicktest70",
                 
"avatar":{
                   
"id":"0wbobrosshappylittlecloudj",
                   
"server":32,
                   
"filename":"bobrosshappylittlecloud.jpg"
                 }
              }
           },
           {
             
"id":"jmc0320306009j",
             
"server":706,
             
"bucket":7676,
             
"filename":"c0320306009.jpg",
             
"original_filename":"c03_20306009.jpeg",
             
"title":null,
             
"creation_date":1360114751,
             
"public":true,
             
"hidden":false,
             
"filesize":260,
             
"width":990,
             
"height":618,
             
"is_owner":false,
             
"owner":{
                 
"username":"nicktest70",
                 
"avatar":{
                   
"id":"0wbobrosshappylittlecloudj",
                   
"server":32,
                   
"filename":"bobrosshappylittlecloud.jpg"
                 }
              }
           }
        ]
     },
     {
       
"id":"nLNQ",
       
"title":"Euro Soccer Championship",
       
"creation_date":1360114734,
       
"public":true,
       
"is_owner":false,
       
"owner":{
           
"username":"nicktest70",
           
"avatar":{
             
"id":"0wbobrosshappylittlecloudj",
             
"server":32,
             
"filename":"bobrosshappylittlecloud.jpg"
           }
        },
       
"total":7,
       
"images":[
           {
             
"id":"0hbp1ayj",
             
"server":17,
             
"bucket":5662,
             
"filename":"bp1ay.jpg",
             
"original_filename":"bp1.jpeg",
             
"title":null,
             
"creation_date":1360114737,
             
"public":true,
             
"hidden":false,
             
"filesize":599,
             
"width":990,
             
"height":659,
             
"is_owner":false,
             
"owner":{
                 
"username":"nicktest70",
                 
"avatar":{
                   
"id":"0wbobrosshappylittlecloudj",
                   
"server":32,
                   
"filename":"bobrosshappylittlecloud.jpg"
                 }
              }
           },
           {
             
"id":"nmbp2sj",
             
"server":850,
             
"bucket":5286,
             
"filename":"bp2s.jpg",
             
"original_filename":"bp2.jpeg",
             
"title":null,
             
"creation_date":1360114738,
             
"public":true,
             
"hidden":false,
             
"filesize":558,
             
"width":990,
             
"height":696,
             
"is_owner":false,
             
"owner":{
                 
"username":"nicktest70",
                 
"avatar":{
                   
"id":"0wbobrosshappylittlecloudj",
                   
"server":32,
                   
"filename":"bobrosshappylittlecloud.jpg"
                 }
              }
           },
           {
             
"id":"embp3ij",
             
"server":526,
             
"bucket":9205,
             
"filename":"bp3i.jpg",
             
"original_filename":"bp3.jpeg",
             
"title":null,
             
"creation_date":1360114741,
             
"public":true,
             
"hidden":false,
             
"filesize":660,
             
"width":990,
             
"height":590,
             
"is_owner":false,
             
"owner":{
                 
"username":"nicktest70",
                 
"avatar":{
                   
"id":"0wbobrosshappylittlecloudj",
                   
"server":32,
                   
"filename":"bobrosshappylittlecloud.jpg"
                 }
              }
           }
        ]
     }
  ]
}

Tag Model

Contains an array of images associated with the tag

Key

Format

Description

total

integer

Number of images total associated with the tag

images

array

An array of Basic Image Models

Json Example:

{
 
"total":3,
 
"images":[
     {
       
"id":"n89lpqc29j",
       
"server":836,
       
"bucket":8860,
       
"filename":"9lpqc29.jpg",
       
"original_filename":"9LpQC29.jpg",
       
"title":null,
       
"album":{
           
"id":"10133250",
           
"title":"new album112",
           
"public":true
        },
       
"creation_date":1367613055,
       
"public":true,
       
"hidden":false,
       
"filesize":62,
       
"width":604,
       
"height":473,
       
"likes":0,
       
"liked":false,
       
"is_owner":true,
       
"owner":{
           
"username":"nicktest96",
           
"avatar":{
             
"id":"my0b90d6626e2f6aa9796cc4cj",
             
"server":826,
             
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
           }
        }
     },
     {
       
"id":"053zdkiwbclj",
       
"server":5,
       
"bucket":8842,
       
"filename":"3zdkiwbcl.jpg",
       
"original_filename":"3ZdkiWB.jpg",
       
"title":null,
       
"album":{
           
"id":null,
           
"title":null,
           
"public":true
        },
       
"creation_date":1367521419,
       
"public":true,
       
"hidden":false,
       
"filesize":192,
       
"width":1000,
       
"height":664,
       
"likes":0,
       
"liked":false,
       
"is_owner":true,
       
"owner":{
           
"username":"nicktest96",
           
"avatar":{
             
"id":"my0b90d6626e2f6aa9796cc4cj",
             
"server":826,
             
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
           }
        }
     },
     {
       
"id":"0letorlkqj",
       
"server":21,
       
"bucket":9743,
       
"filename":"etorlkq.jpg",
       
"original_filename":"eTOrlkQ.jpg",
       
"title":null,
       
"album":{
           
"id":null,
           
"title":null,
           
"public":true
        },
       
"creation_date":1367349449,
       
"public":true,
       
"hidden":false,
       
"filesize":383,
       
"width":1400,
       
"height":900,
       
"likes":0,
       
"liked":false,
       
"is_owner":true,
       
"owner":{
           
"username":"nicktest96",
           
"avatar":{
             
"id":"my0b90d6626e2f6aa9796cc4cj",
             
"server":826,
             
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
           }
        }
     }
  ]
}

Tags List Model

Contains a list of albums from a user account

Key

Format

Description

limit

integer

Number of albums returned (pagination)

offset

integer

Number of albums to offset (pagination)

total

integer

Total number of albums in account

tags

array

An array of Tag Model

Json Example:

{
 
"limit":25,
 
"offset":0,
 
"total":3,
 
"tags":{
     
"animals":{
       
"total":3,
       
"images":[
           {
             
"id":"n89lpqc29j",
             
"server":836,
             
"bucket":8860,
             
"filename":"9lpqc29.jpg",
             
"original_filename":"9LpQC29.jpg",
             
"title":null,
             
"album":{
                 
"id":"10133250",
                 
"title":"new album112",
                 
"public":true
              },
             
"creation_date":1367613055,
             
"public":true,
             
"hidden":false,
             
"filesize":62,
             
"width":604,
             
"height":473,
             
"likes":0,
             
"liked":false,
             
"is_owner":true,
             
"owner":{
                 
"username":"nicktest96",
                 
"avatar":{
                   
"id":"my0b90d6626e2f6aa9796cc4cj",
                   
"server":826,
                   
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
                 }
              }
           },
           {
             
"id":"053zdkiwbclj",
             
"server":5,
             
"bucket":8842,
             
"filename":"3zdkiwbcl.jpg",
             
"original_filename":"3ZdkiWB.jpg",
             
"title":null,
             
"album":{
                 
"id":null,
                 
"title":null,
                 
"public":true
              },
             
"creation_date":1367521419,
             
"public":true,
             
"hidden":false,
             
"filesize":192,
             
"width":1000,
             
"height":664,
             
"likes":0,
             
"liked":false,
             
"is_owner":true,
             
"owner":{
                 
"username":"nicktest96",
                 
"avatar":{
                   
"id":"my0b90d6626e2f6aa9796cc4cj",
                   
"server":826,
                   
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
                 }
              }
           },
           {
             
"id":"0letorlkqj",
             
"server":21,
             
"bucket":9743,
             
"filename":"etorlkq.jpg",
             
"original_filename":"eTOrlkQ.jpg",
             
"title":null,
             
"album":{
                 
"id":null,
                 
"title":null,
                 
"public":true
              },
             
"creation_date":1367349449,
             
"public":true,
             
"hidden":false,
             
"filesize":383,
             
"width":1400,
             
"height":900,
             
"likes":0,
             
"liked":false,
             
"is_owner":true,
             
"owner":{
                 
"username":"nicktest96",
                 
"avatar":{
                   
"id":"my0b90d6626e2f6aa9796cc4cj",
                   
"server":826,
                   
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
                 }
              }
           }
        ]
     },
     
"bird":{
       
"total":1,
       
"images":[
           {
             
"id":"0letorlkqj",
             
"server":21,
             
"bucket":9743,
             
"filename":"etorlkq.jpg",
             
"original_filename":"eTOrlkQ.jpg",
             
"title":null,
             
"album":{
                 
"id":null,
                 
"title":null,
                 
"public":true
              },
             
"creation_date":1367349449,
             
"public":true,
             
"hidden":false,
             
"filesize":383,
             
"width":1400,
             
"height":900,
             
"likes":0,
             
"liked":false,
             
"is_owner":true,
             
"owner":{
                 
"username":"nicktest96",
                 
"avatar":{
                   
"id":"my0b90d6626e2f6aa9796cc4cj",
                   
"server":826,
                   
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
                 }
              }
           }
        ]
     },
     
"elephant":{
       
"total":2,
       
"images":[
           {
             
"id":"053zdkiwbclj",
             
"server":5,
             
"bucket":8842,
             
"filename":"3zdkiwbcl.jpg",
             
"original_filename":"3ZdkiWB.jpg",
             
"title":null,
             
"album":{
                 
"id":null,
                 
"title":null,
                 
"public":true
              },
             
"creation_date":1367521419,
             
"public":true,
             
"hidden":false,
             
"filesize":192,
             
"width":1000,
             
"height":664,
             
"likes":0,
             
"liked":false,
             
"is_owner":true,
             
"owner":{
                 
"username":"nicktest96",
                 
"avatar":{
                   
"id":"my0b90d6626e2f6aa9796cc4cj",
                   
"server":826,
                   
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
                 }
              }
           },
           {
             
"id":"n89lpqc29j",
             
"server":836,
             
"bucket":8860,
             
"filename":"9lpqc29.jpg",
             
"original_filename":"9LpQC29.jpg",
             
"title":null,
             
"album":{
                 
"id":"10133250",
                 
"title":"new album112",
                 
"public":true
              },
             
"creation_date":1367613055,
             
"public":true,
             
"hidden":false,
             
"filesize":62,
             
"width":604,
             
"height":473,
             
"likes":0,
             
"liked":false,
             
"is_owner":true,
             
"owner":{
                 
"username":"nicktest96",
                 
"avatar":{
                   
"id":"my0b90d6626e2f6aa9796cc4cj",
                   
"server":826,
                   
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
                 }
              }
           }
        ]
     }
  }
}

Image Comment Model

Key

Format

Description

id

string

Message unique id as a string

comment

string

Text portion of the comment

source

string

Source of the create call. Web, Mobile, App name, etc

owner->username

string

Username of the owner of the comment

owner->avatar->id

string

Unique alphanumeric id of user’s avatar image

owner->avatar->server

integer

Server location of the owner’s avatar

owner->avatar->filename

string

Filename of the owner’s avatar

Json Example

{
 
"id":"x4hw3lg1uq",
 
"comment":"cool image",
 
"source":"",
 
"owner":{
     
"username":"nick",
     
"avatar":{

         "id":"2i0b90d6626e2f6aa9796cc4cj”,
       
"server":90,
       
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
     }
  },
 
"likes":0,
 
"liked":false,
 
"creation_date":1368772064
}

Image Comments List Model

Key

Format

Description

limit

integer

Number of comments displayed

end_offset

string

End offset. Used for pagination.

start_offset

string

Start offset. Used for pagination.

total

integer

Total number of comments

comments

array

An array of Comment Models

Json Example

{
 
"limit":3,
 
"end_offset":"ODUzLXNjcmVlbnNob3QyMDEzMDUwM2F0MjU3LnBuZzp",
 
"start_offset":"ODUzLXNjcmVlbnNob3QyMDEzMDUwM2F0MjU3LnBuZzp",
 
"total":5,
 
"comments":[
     {
       
"id":"10xaeb7h1o",
       
"comment":"cool image 3",
       
"source":"",
       
"owner":{
           
"username":"nicktest",
           
"avatar":{
             
"server":0,
             
"filename":null
           }
        },
       
"likes":0,
       
"liked":false,
       
"creation_date":1368772120
     },
     {
       
"id":"6uivsbl71l",
       
"comment":"cool image 4",
       
"source":"your mom",
       
"owner":{
           
"username":"nicktest96",
           
"avatar":{
             
"server":826,
             
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
           }
        },
       
"likes":0,
       
"liked":false,
       
"creation_date":1368772167
     },
     {
       
"id":"qqsbtij9d0",
       
"comment":"cool image 4",
       
"source":"",
       
"owner":{
           
"username":"nicktest96",
           
"avatar":{
             
"server":826,
             
"filename":"0b90d6626e2f6aa9796cc4c.jpg"
           }
        },
       
"likes":0,
       
"liked":false,
       
"creation_date":1368772137
     }
  ]
}

Bulk Model

Key

Format

Description

passed

integer

Number of successful requests

failed

integer

Number of failed requests

total

integer

Total number of requests

{title}

array

Array of result models depending on the usage

Followers Images Model

Contains a list of images from followers/followings

Key

Format

Description

limit

integer

Limit the number of images to display

start_offset

string

End offset. Used for pagination.

end_offset

string

Start offset. Used for pagination.

images

array

An array of Basic Image Models

Json Example

{
 
"limit":3,
 
"end_offset":"104657061414141414141526269415136662f2f2b7674434a547267364e533169654770314c6d70775a773d3d",
 
"start_offset":null,
 
"offset":null,
 
"images":[
     {
       
"id":"0w4fkoj",
       
"server":32,
       
"bucket":3613,
       
"filename":"4fko.jpg",
       
"original_filename":"4fko.jpg",
       
"title":null,
       
"album":{
           
"id":null,
           
"title":null,
           
"public":true
        },
       
"creation_date":1379480828,
       
"public":true,
       
"hidden":false,
       
"filesize":192,
       
"width":1000,
       
"height":664,
       
"likes":0,
       
"liked":false,
       
"is_owner":false,
       
"owner":{
           
"username":"testingfrogdude1",
           
"avatar":{
             
"id":"cbdo0nj",
             
"server":443,
             
"filename":"do0n.jpg"
           }
        }
     },
     {
       
"id":"2hr34kj",
       
"server":89,
       
"bucket":9497,
       
"filename":"r34k.jpg",
       
"original_filename":"r34k.jpg",
       
"title":null,
       
"album":{
           
"id":null,
           
"title":null,
           
"public":true
        },
       
"creation_date":1379480861,
       
"public":true,
       
"hidden":false,
       
"filesize":428,
       
"width":1920,
       
"height":1080,
       
"likes":0,
       
"liked":false,
       
"is_owner":false,
       
"owner":{
           
"username":"testingfrogdude1",
           
"avatar":{
             
"id":"cbdo0nj",
             
"server":443,
             
"filename":"do0n.jpg"
           }
        }
     },
     {
       
"id":"48f7ij",
       
"server":152,
       
"bucket":6936,
       
"filename":"f7i.jpg",
       
"original_filename":"f7i.jpg",
       
"title":null,
       
"album":{
           
"id":null,
           
"title":null,
           
"public":true
        },
       
"creation_date":1379481640,
       
"public":true,
       
"hidden":false,
       
"filesize":174,
       
"width":1920,
       
"height":1080,
       
"likes":0,
       
"liked":false,
       
"is_owner":false,
       
"owner":{
           
"username":"testingfrogdude1",
           
"avatar":{
             
"id":"cbdo0nj",
             
"server":443,
             
"filename":"do0n.jpg"
           }
        }
     }
  ]
}

Endpoints

User API


Get User

Gets user information

Route

https://api.imageshack.com/v2/user/<username>

Method

GET

Response

User Model

Params

Key

Required

Value

image_limit

n

limits the number of latest images to display. defaults 5

Create User

Create a new user

Route

https://api.imageshack.com/v2/user

Method

POST

Response

login Model

Params

Key

Required

Value

email

y

Specify an email for the new user

username

n

Specify a username for the new user. If none specified a username will be created from the email address.

password

n

Specify a password for the new user. If none is specified a random password will be generated. The password will be sent to the email address.

first_name

n

User's first name. Requires last_name

last_name

n

User's last name. Requires first_name

gender

n

User's gender

location

n

User's location

description

n

User bio

set_cookies

n

When TRUE auth cookies will be set in the user's browser after successful sign up

remember_me

n

When TRUE and used with set_cookies the cookies will expire in 365 days instead of after session close.

Update User

Update user account. You must be logged in.

Route

https://api.imageshack.com/v2/user/<username>

Method

PUT/PATCH

Response

User Model

Params

Key

Required

Value

username

n

Specify a new username for the user

email

n

Specify a new email for the user

password

n

Specify a new password for the user

first_name

n

User's first name. Requires last_name

last_name

n

User's last name. Requires first_name

gender

n

User's gender

location

n

User's location

description

n

User bio

avatar_sever

n

Avatar's server location. Requires avatar_filename

avatar_filename

n

Avatar's filename. Requires avatar_server

Delete User

Delete user account. Require authentication.

Route

https://api.imageshack.com/v2/user/<username>

Method

DELETE

Response

TRUE/FALSE

Get User Usage

Gets user usage and media counts

Route

https://api.imageshack.com/v2/user/<username>/usage

Method

GET

Response

Usage Model

Params

key

Required

Value

hide_empty

n

Exclude empty albums from album count

show_private

n

Includes private images in counts

show_hidden

n

Includes hidden(deleted) images in counts

Get User Settings

Gets user settings such as privacy and notifications settings. Requires Authentication.

Route

https://api.imageshack.com/v2/user/settings

Method

GET

Response

Setting Model

Update User Settings

Gets user settings such as privacy and notifications settings. Requires Authentication.

Route

https://api.imageshack.com/v2/user/settings

Method

PUT or PATCH

Response

Setting Model

Params

key

Required

Value

private_profile

n

Sets profile to be private. Public pages will not be viewable

private_images

n

Sets images to be non-public by default on upload

private_albums

n

Sets albums to be non-public by default on upload

private_files

n

Sets files to be non-public by default on upload

private_followings

n

Toggles user following privacy setting

upload_notification

n

Toggles notifications for all uploads

comments_notification

n

Toggles notifications for comments

shares_notification

n

Toggles notifications for shared images

likes_notification

n

Toggles notifications for liked images

follows_notification

n

Toggles notifications for following events

new_feature_notification

n

Toggles notifications for new features

weekly_update_notification

n

Toggles notifications for weekly uploads report

daily_update_notification

n

Toggles notifications for daily uploads report

skypath_message

n

Toggles notifications for Skypath messages

skypath_share_file

n

Toggles notifications for Skypath shared images

onboarding

n

Toggles onboarding flag

Get User Images

Provides a list of the all the images associated with the user

Route

https://api.imageshack.com/v2/user/<username>/images

Method

GET

Response

Images List Model

Params

key

Required

Value

show_private

n

include private images. Requires authentication

show_hidden

n

Includes hidden(deleted) images. Requires authentication.

hide_folder_images

n

Hides images from albums

show_only_private

n

Return only private images. Requires authentication

Get Random User Images

Provides a random list of images associated with the user

Route

https://api.imageshack.com/v2/user/<username>/images/random

Method

GET

Response

array of Basic Image Models

Get user albums

Provides a list of the all the albums associated with the user

Route

https://api.imageshack.com/v2/user/<username>/albums

Method

GET

Response

Albums List Model

Params

key

Required

Values

image_limit

n

Number of images to return for each album

show_private

n

Include private images. Requires authentication

hide_empty

n

Hides empty albums

show_only_private

n

Return only private albums. Requires authentication

Get user tags

Provides a list of the all the tags w/ images associated with the user. Requires authentication.

Route

https://api.imageshack.com/v2/user/<username>/tags

Method

GET

Response

Tags List Model

Params

Key

Required

Value

limit

n

Number of images returned (pagination)

offset

n

Number of images to offset (pagination)

sort

n

Specifies sort order. ‘asc’, ‘desc’, and ‘count’. asc and desc will sort by tag name. Count will sort by number of images ascending. default is asc

image_limit

n

Specifies the number of images to return for each tag

tags_by_letter

n

Return all tags starting with the following letter

Search User Tags

Searches through an accounts tags. Retrieves images associated with tags. Requires authentication.

Route

https://api.imageshack.com/v2/user/<username>/tags/<tags>

Method

GET

Response

Array of Basic Image Models

Params

Key

Required

Value

limit

n

Number of images returned (pagination)

offset

n

Number of images to offset (pagination)

Forgot Password

Sends a forgot password reset email to user

Route

https://api.imageshack.com/v2/user/<user>/forgot

Method

POST

Response

TRUE/FALSE

Password reset

Reset password with auth hash from forgot password API

Route

https://api.imageshack.com/v2/user/<user>/password_reset

Method

POST

Response

TRUE/FALSE

Params

Key

Required

Value

auth

y

The auth hash from Forgot Password API email response.

password

y

A new password

Image API


Upload image

Upload an image. Requires authentication.

Route

https://api.imageshack.com/v2/images

Method

POST

Response

Upload Model

Params

Key

Required

Value

file(s[])@

y

Image binary(s). May send multiple images. Use ‘files[]’ array param when sending multiple images.

album

n

Album title or album id to attach files to. If album exists files will be added. If not a new album will be created.

title(s[])

n

Set a title for the image. Use ‘titles[]’ array param or ‘titles’ param separated by commas for multiple image titles.

description(s[])

n

Set a description for the image. Use descriptions[]’ array param or descriptions param separated by commas for multiple image descriptions.

tags

n

List of tags to attach to the image. Array or csv

public

n

Sets public setting. Default is true.

filter

n

User specified image filter 0-23. 0 is no filter. Will be applied images transloaded.

comments_disabled

n

Disable comments for the specific image

Transload image

transload an image. Requires authentication.

Route

https://api.imageshack.com/v2/images

Method

POST

Response

Upload Model

Params

Key

Required

Value

urls[]

y

Url(s) of image(s) to transload

album

n

Album title or album id to attach files to. If album exists files will be added. If not a new album will be created.

title(s[])

n

Set a title for the image. Use ‘titles[]’ array param or ‘titles’ param separated by commas for multiple image titles.

description(s[])

n

Set a description for the image. Use descriptions[]’ array param or descriptions param separated by commas for multiple image descriptions.

tags

n

List of tags to attach to the image. Array or csv

public

n

Sets public setting. Default is true. Will be applied images transloaded.

filter

n

User specified image filter 0-23. 0 is no filter. Will be applied images transloaded.

comments_disabled

n

Disable comments for the specific image

Get Image

Get an image

Route

https://api.imageshack.com/v2/images/<id>

Method

GET

Params

Key

Required

Values

next_prev_limit

n

Sets the limit of next and previous images returned. Default is 2

related_images_limit

n

Sets the limit of related images to be returned. Default is 10

Get Multiple Images

Lookup multiple images

Route

https://api.imageshack.com/v2/images

Method

GET

Response

Bulk Model

Params

Key

Required

Values

ids

y

Comma separated list of image IDs or ids[] array.

Example:

ids=eb96484058j,go4anjaj,bb3zdkiwbj

or

ids[]=eb96484058j

ids[]=go4anjaj

ids[]=bb3zdkiwbj

next_prev_limit

n

Sets the limit of next and previous images returned. Default is 2

Update Image

Updates an image’s properties. Requires authentication.

Route

https://api.imageshack.com/v2/images/<id>

Method

PUT/PATCH

Response

Image Model

Params

Key

Required

Values

title

n

Set a title for the image

description

n

Set a description for the image

tags

n

List of tags to attach to the image. Array or csv

original_filename

n

Rename the original_filename.

public

n

Sets public setting. Default is true.

filter

n

User specified image filter 0-23. 0 is no filter.

comments_disabled

n

Disable comments for the specific image

Update Multiple Images

Updates multiple images

Route

https://api.imageshack.com/v2/images

Method

PUT/PATCH

Response

Bulk Model

Params

Key

Required

Values

ids

y

Comma separated list of image IDs or ids[] array.

Example:

ids=eb96484058j,go4anjaj,bb3zdkiwbj

or

ids[]=eb96484058j

ids[]=go4anjaj

ids[]=bb3zdkiwbj

title

n

Set a title for the image

description

n

Set a description for the image

tags

n

List of tags to attach to the image. Array or csv

public

n

Sets public setting. Default is true.

filter

n

User specified image filter 0-23. 0 is no filter.

comments_disabled

n

Disable comments for the specific image

Delete Image

Delete an image. Requires authentication.

Route

https://api.imageshack.com/v2/images/<id>

Method

DELETE

Response

TRUE/FALSE

Delete bulk Images

Delete multiple images. Requires authentication.

Route

https://api.imageshack.com/v2/images

Method

DELETE

Response

Bulk Model

Params

Key

Required

Values

ids

y

Comma separated list of image IDs or ids[] array.

Example:

ids=eb96484058j,go4anjaj,bb3zdkiwbj

or

ids[]=eb96484058j

ids[]=go4anjaj

ids[]=bb3zdkiwbj

Get image likes

Gets a list of users who liked the image. Requires authentication of image owner.

Route

https://api.imageshack.com/v2/images/<id>/likes

Method

GET

Response

array of User Model

Like image

Likes an image. Requires authentication.

Route

https://api.imageshack.com/v2/images/<id>/likes

Method

POST/PUT

Response

TRUE/FALSE

Unlike image

Unlikes an image. Requires authentication.

Route

https://api.imageshack.com/v2/images/<id>/unlike

Method

POST/PUT

Response

TRUE/FALSE

Get Related images

Returns a list of related images.

Route

https://api.imageshack.com/v2/images/<id>/related

Method

GET

Response

Array of server and file names

Params

Key

Required

Values

limit

n

Sets the limit of related images to be returned. Default is 10

Get Image tags

Get tags from image

Route

https://api.imageshack.com/v2/images/<id>/tags

Method

GET

Response

Array of Tags

Tag Image

Tag an image with one or more tags. Requires authentication.

Route

https://api.imageshack.com/v2/images/<id>/tags

Method

PUT

Response

TRUE/FALSE

Params

Key

Required

Values

tags

y

List of tags to attach to image. Array or csv

Tag Images

Tag multiple images with one or more tags. Requires authentication.

Route

https://api.imageshack.com/v2/images/tags

Method

PUT

Response

Bulk Model

Params

Key

Required

Values

ids

y

List of image IDs. Array or csv.

tags

y

List of tags to attach to image. Array or csv

Delete Image Tags

Remove one or more tags from an image. Requires authentication.

Route

https://api.imageshack.com/v2/images/<image_id>/tags

Method

DELETE

Response

Bulk Model

Params

Key

Required

Values

tags

n

List of tags to remove from image. If omitted all tags will be removed.

Delete Images Tags

Remove one or more tags from multiple images. Requires authentication.

Route

https://api.imageshack.com/v2/images/tags

Method

DELETE

Response

Bulk Model

Params

Key

Required

Values

ids

y

List of image IDs. Array or csv.

tags

n

List of tags to remove from image. If omitted all tags will be removed.

Album API


Create Album

Creates a new album. Require authentication.

Route

https://api.imageshack.com/v2/albums

Method

POST

Response

Album Model

Params

Key

Required

Values

title

y

The title of the album

description

n

Set a description for the album. 200 char limit.

public

n

Set album privacy level. Default is TRUE.

files[]

n

Array of image ids to add to the newly created album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj

Get Album

Get an album

Route

https://api.imageshack.com/v2/albums/<id>

Method

GET

Response

Album Model

Get Multiple Albums

Lookup multiple albums

Route

https://api.imageshack.com/v2/albums

Method

GET

Response

Bulk Model

Params

Key

Required

Values

ids

y

Comma separated list of album IDs or ids[] array

Example:

ids=TzcF,i5VF

or

ids[]=TzcF

ids[]=i5VF

Update Album

Update an album. Require authentication.

Route

https://api.imageshack.com/v2/albums/<id>

Method

PUT/PATCH

Response

Album Model

Params

Key

Required

Values

title

n

The title of the album

description

n

Set a description for the image

public

n

Set album privacy level. Default is TRUE.

Update Multiple Albums

Updates multiple albums. Require authentication.

Route

https://api.imageshack.com/v2/albums

Method

PUT/PATCH

Response

Bulk Model

Params

Key

Required

Values

ids

y

Comma separated list of album IDs or ids[] array

Example:

ids=TzcF,i5VF

or

ids[]=TzcF

ids[]=i5VF

description

n

Set a description for the image

public

n

Set album privacy level. Default is TRUE.

Set album Images

Set or replace images in an album. Require authentication.

Route

https://api.imageshack.com/v2/albums/<id>

Method

PUT/PATCH

Response

Album Model

Params

Key

Required

Values

files[]

y

Array of image ids to replace images in existing album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj

Add Images to Album

Add new images to an album. Require authentication.

Route

https://api.imageshack.com/v2/albums/<id>/add_files

Method

PUT/PATCH

Response

Album Model

Params

Key

Required

Values

files[]

y

Array of image ids to add to an existing album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj

Delete Images from Album

Delete images from an album. Require authentication.

Route

https://api.imageshack.com/v2/albums/<id>/delete_files

Method

PUT/PATCH

Response

Album Model

Params

Key

Required

Values

files[]

y

Array of image ids to delete from an existing album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj

Delete Album

Delete an album. Require authentication.

Route

https://api.imageshack.com/v2/albums/<id>

Method

DELETE

Response

TRUE/FALSE

Delete Multiple Albums

Deletes multiple albums. Require authentication.

Route

https://api.imageshack.com/v2/albums

Method

PUT/PATCH

Response

Bulk Model

Params

Key

Required

Values

ids

y

Comma separated list of album IDs or ids[] array

Example:

ids=TzcF,i5VF

or

ids[]=TzcF

ids[]=i5VF

Tags API


Search Site Images by Tags

Searches sitewide for public images by tags

Route

https://api.imageshack.com/v2/tags/<tags>

Method

GET

Response

Array of Mini Image Models

Params

Key

Required

Values

limit

n

Number of images returned (pagination)

offset

n

Number of images to offset (pagination)

Comments API


Get Comments

Gets a list of comments associated with image. Authorization required.

Route

https://api.imageshack.com/v2/images/<image_id>

/comments

Method

GET

Response

Comments List Model

Params

Key

Required

Values

limit

n

Number of comments to returned. Default 10.

offset

n

The offset key to start from. Comments API uses a different pagination technique. Use the end_offset or start_offset keys from previous API results to move forward or backwards through pages.

Add Comment

Add a comment to image. Authorization required.

Route

https://api.imageshack.us/v1/images/<image_id>/comments

Method

POST

Response

TRUE/FALSE

Params

Key

Required

Values

comment

y

The text portion of the comment.

source

n

Source of comment. Example: Web, Mobile, Name of App, etc

Delete Comment

Delete a comment. Authorization required.

Route

https://api.imageshack.us/v1/comments/<comment_id>

Method

DELETE

Response

TRUE/FALSE

Follow API


Follow User

Follow a user. Require authentication.

Route

https://api.imageshack.com/v2/follows/<username>

Method

POST

Response

TRUE/FALSE

Unfollower User

UnFollow a user. Require authentication.

Route

https://api.imageshack.com/v2/follows/<username>

Method

DELETE

Response

TRUE/FALSE

Get Followers

Gets a list of users following you. Require authentication.

Route

https://api.imageshack.com/v2/user/<username>/followers

Method

GET

Response

Array of User Models

Get Followings

Gets a list of users you are following. Require authentication.

Route

https://api.imageshack.com/v2/user/<username>/followings

Method

GET

Response

Array of User Models

Get Followers Images

Gets a list of images of users following you. Require authentication.

Route

https://api.imageshack.com/v2/user/<username>/followers/images

Method

GET

Response

Followers Images Model

Get Following Images

Gets a list of images from users you are following. Require authentication.

Route

https://api.imageshack.com/v2/user/<username>/followings/images

Method

GET

Response

Followers Images Model

Search API


Search Sitewide Images

Search through all imageshack’s public user images. Searches by image filename, image title, image tags, and album title.

Route

https://api.imageshack.com/v2/search/<search term>

Method

GET

Response

array or Basic Image Models

Search Specific User

Search through specific user’s public images. Searches by image filename, image title, image tags, and album title.

Route

http://api.imageshack.com/v2/user/<username>/images/search/<search term>

Method

GET

Response

array or Basic Image Models