Website logo

Retrieve your photos, with usage details

Returns a list of all currently available photos uploaded by authenticated user. Includes information about which auctions are currently using each photo.

URL: https://api.trademe.co.nz/v1/photos/details.{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 TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <MemberPhoto> or null InnerList
Id Integer Id
Description String or null Description
IsUsed Boolean IsUsed
Auctions Collection of Integer or null Auctions
PhotoUrls <PhotoUrl> or null PhotoUrls
Thumbnail String or null Thumbnail
List String or null List
Medium String or null Medium
Gallery String or null Gallery
Large String or null Large
FullSize String or null FullSize
PlusSize String or null PlusSize
PhotoId Integer PhotoId
OriginalWidth Integer OriginalWidth
OriginalHeight Integer OriginalHeight

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
    }
  ]
}