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 CharityType
None 0 None
ForestAndBird 1 ForestAndBird
Plunket 2 Plunket
StJohn 3 StJohn
OurPeopleOurCityFund 4 OurPeopleOurCityFund
WomensRefuge 5 WomensRefuge
KidsCan 6 KidsCan
ImageSource String or null ImageSource
DarkModeImageSource String or null DarkModeImageSource
Description String or null Description
Tagline String or null Tagline

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