Website logo

Retrieve your photos

Returns a list of all currently available photos uploaded by authenticated user.

URL: https://api.trademe.co.nz/v1/Photos.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.

rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 50.

Returns

<MemberPhotos>

A collection of MemberPhoto.

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.

Page Integer

The index of the current page of results (starts at 1).

PageSize Integer

The number of results in the current page.

List Collection of <MemberPhoto> or null

A list of the results in the current page.

Id Integer

The ID of the photo.

Description String or null

The description accompanying the photo.

IsUsed Boolean

Indicates whether this photo is used.

Auctions Collection of Long Integer or null

A list of IDs of the auctions this photo is used in.

PhotoUrls <PhotoUrl> or null

A collection of URLs for this photo, one for each size.

Thumbnail String or null

The URL for the thumbnail sized photo (always 85x64, with white borders).

List String or null

The URL for the list view sized photo (scaled down to fit 160x120).

Medium String or null

The URL for the medium sized photo (scaled down to fit 175x175).

Gallery String or null

The URL for the gallery sized photo (scaled down to fit 233x176).

Large String or null

The URL for the large sized photo (scaled down to fit 352x264).

FullSize String or null

The URL for the full sized photo (scaled down to fit 670x502).

PlusSize String or null

The URL for the plus sized photo (scaled down to fit).

PhotoId Integer

The ID of the photo.

OriginalWidth Integer

The original image width in pixels.

OriginalHeight Integer

The original image height in pixels.

Example XML Response (switch to JSON)

<MemberPhotos xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <MemberPhoto>
      <Id>123</Id>
      <Description>ABC</Description>
      <IsUsed>false</IsUsed>
      <Auctions>
        <Auction>123</Auction>
        <Auction>123</Auction>
      </Auctions>
      <PhotoUrls>
        <Thumbnail>ABC</Thumbnail>
        <List>ABC</List>
        <Medium>ABC</Medium>
        <Gallery>ABC</Gallery>
        <Large>ABC</Large>
        <FullSize>ABC</FullSize>
        <PlusSize>ABC</PlusSize>
        <PhotoId>123</PhotoId>
      </PhotoUrls>
      <OriginalWidth>123</OriginalWidth>
      <OriginalHeight>123</OriginalHeight>
    </MemberPhoto>
    <MemberPhoto>
      <Id>123</Id>
      <Description>ABC</Description>
      <IsUsed>false</IsUsed>
      <Auctions>
        <Auction>123</Auction>
        <Auction>123</Auction>
      </Auctions>
      <PhotoUrls>
        <Thumbnail>ABC</Thumbnail>
        <List>ABC</List>
        <Medium>ABC</Medium>
        <Gallery>ABC</Gallery>
        <Large>ABC</Large>
        <FullSize>ABC</FullSize>
        <PlusSize>ABC</PlusSize>
        <PhotoId>123</PhotoId>
      </PhotoUrls>
      <OriginalWidth>123</OriginalWidth>
      <OriginalHeight>123</OriginalHeight>
    </MemberPhoto>
  </List>
</MemberPhotos>

Example JSON Response (switch to XML)

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "Id": 123,
      "Description": "ABC",
      "IsUsed": false,
      "Auctions": [
        123,
        123
      ],
      "PhotoUrls": {
        "Thumbnail": "ABC",
        "List": "ABC",
        "Medium": "ABC",
        "Gallery": "ABC",
        "Large": "ABC",
        "FullSize": "ABC",
        "PlusSize": "ABC",
        "PhotoId": 123
      },
      "OriginalWidth": 123,
      "OriginalHeight": 123
    },
    {
      "Id": 123,
      "Description": "ABC",
      "IsUsed": false,
      "Auctions": [
        123,
        123
      ],
      "PhotoUrls": {
        "Thumbnail": "ABC",
        "List": "ABC",
        "Medium": "ABC",
        "Gallery": "ABC",
        "Large": "ABC",
        "FullSize": "ABC",
        "PlusSize": "ABC",
        "PhotoId": 123
      },
      "OriginalWidth": 123,
      "OriginalHeight": 123
    }
  ]
}