Knowledge Base: images.index

Method Type: GET
Parameters: page

Displays the last 20 public images uploaded to Ember as an array.

Usage

http://api.emberapp.com/images/index

// Pagination can be archived by adding page/{page}
http://api.emberapp.com/images/index/page/2

Response

Each image is returned with the following parameters.

image item:

name:           Name of the image: [string]
token:          Unique identifier for the image. [string]
shared_token:   Token for the parent image if it exists. [string]
description:    Description of the image. [string]
rating:         Rating of the image 0-5. [int]
url:            The original url of the image (if web snap). [string]
date_taken:     Unix timestamp the image was created. [int]
slug:           The slug used by the image on the site unique to the owner. [string]
views:          The number of times the image has been viewed. [int]
created:        Unix Timestamp the image was added. [int]
user:           User information. [array]
file:           File information for the medium image. [array]
permalink:      URL to the image page on Ember [string]

user item:

username:       Users username and unique identifier. [string]
fullname:       Users fullname. [string]
bio:            Users bio. [string]
url:            Users homepage. [string]
total_images:   Total images the user has uploaded to Ember. [int]
avatar:         Array containing the medium avatar information. [array]

file item:

size:           Size flag of the image (sq, t, s, m, l, o). [string]
width:          Width in px of the image. [int]
height:         Height in px of the image. [int]
filesize:       Size in bytes of the file. [int]
src:            Url to the file for the image. [string]

Example XML Response

<?xml version="1.0"?>
<response>
    <status code="0">OK</status>
    <api>api.images.index</api>
    <images>
        <image>
            <name>Sam Brown</name>
            <token>140162938749007d0e2a862</token>
            <shared_token>140162938749007d0e2a862</shared_token>
            <description>Sam Brown's personal blog.</description>
            <rating>5</rating>
            <url>http://sam.brown.tc/</url>
            <date_taken>1224764177</date_taken>
            <slug>sam-brown</slug>
            <views>540</views>
            <created>1224768783</created>
            <user>
                <username>ac94</username>
                <fullname>Aron</fullname>
                <bio>I'm a web developer at Realmac Software</bio>
                <url>http://emberapp.com</url>
                <default_privacy>1</default_privacy>
                <total_images>75</total_images>
            </user>
            <file>
                <size>m</size>
                <width>600</width>
                <height>1933</height>
                <filesize>148672</filesize>
                <src>http://emberapp.com/ac94/images/sam-brown/sizes/m.jpg</src>
            </file>
            <permalink>http://emberapp.com/ac94/images/sam-brown</permalink>
        </image>
        <image>
            <name>Drowned In Sound</name>
            <token>123717114249007c73f1873</token>
            <shared_token>123717114249007c73f1873</shared_token>
            <description/>
            <rating>0</rating>
            <url>http://drownedinsound.com/</url>
            <date_taken>1224765417</date_taken>
            <slug>drowned-in-sound</slug>
            <views>535</views>
            <created>1224768628</created>
            <user>
                <username>ac94</username>
                <fullname>Aron</fullname>
                <bio>I'm a web developer at Realmac Software</bio>
                <url>http://emberapp.com</url>
                <default_privacy>1</default_privacy>
                <total_images>75</total_images>
            </user>
            <file>
                <size>m</size>
                <width>600</width>
                <height>2121</height>
                <filesize>261244</filesize>
                <src>http://emberapp.com/ac94/images/drowned-in-sound/sizes/m.jpg</src>
            </file>
            <permalink>http://emberapp.com/ac94/images/drowned-in-sound</permalink>
        </image>
    </images>
</response>