Website logo

Retrieve list of charities

Retrieves a collection of charities available to donate to when listing.

URL: https://api.trademe.co.nz/v1/Charities.{file_format}
HTTP Method: GET
Requires Authentication? No
Permission Required: Public
Supported Formats: XML, JSON
Rate Limited? No

URL parameters

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

Returns

Collection of <Charity>

Charities collection.

CharityType Enumeration

The unique identifier of the charity.

None 0

The default charity identifier. Used if the user chose not to donate to a charity at all.

ForestAndBird 1

Donate to Forest and Bird's kiwis for kiwis program.

Plunket 2

Donate to Plunket.

StJohn 3

Donate to St John.

OurPeopleOurCityFund 4

Donate to Our People, Our City Fund.

ImageSource String or null

The URL for this charity's brand image (designed for a light background).

DarkModeImageSource String or null

The URL for this charity's brand image (designed for a dark background).

Description String or null

The name of the charity e.g. "Plunket", "Kiwis for kiwi".

Tagline String or null

A short description of what the charity does.

Example XML Response (switch to JSON)

<CharityCollection xmlns="http://api.trademe.co.nz/v1">
  <Charity>
    <CharityType>None</CharityType>
    <ImageSource>ABC</ImageSource>
    <DarkModeImageSource>ABC</DarkModeImageSource>
    <Description>ABC</Description>
    <Tagline>ABC</Tagline>
  </Charity>
  <Charity>
    <CharityType>None</CharityType>
    <ImageSource>ABC</ImageSource>
    <DarkModeImageSource>ABC</DarkModeImageSource>
    <Description>ABC</Description>
    <Tagline>ABC</Tagline>
  </Charity>
</CharityCollection>

Example JSON Response (switch to XML)

[
  {
    "CharityType": 0,
    "ImageSource": "ABC",
    "DarkModeImageSource": "ABC",
    "Description": "ABC",
    "Tagline": "ABC"
  },
  {
    "CharityType": 0,
    "ImageSource": "ABC",
    "DarkModeImageSource": "ABC",
    "Description": "ABC",
    "Tagline": "ABC"
  }
]