API Index

Search by address

Place a bid (normal or auto-bid) on a listing.

Buys an item using Buy Now.

Selects a delivery address for an auction you've won and sends that information, along with an optional phone number and message, to the seller. Do not use this API if the buyer is planning to pay with Pay Now, since the Pay Now process already includes this step. An address can only be sent once; the buyer must contact the seller directly if there was a mistake.

Adds an image to the authenticated user's list of branding images. These photos can be used when listing a classified. Branding images are only supported for Job listings.

• Logo
• Banner
• Square

• JPEG or JPG
• PNG
• GIF

Returns a list of branding images associated with a member. The response includes the Url to the branding images.

Returns a branding image associated with a member. The response includes the Url to the branding image.

Update the priority of a specific branding image given the branding id in the url.

It sets the branding image specified in the url to the default for its branding image type. For example, if the member has two branding logos, the branding logo they specify in the url will become the default. Success will always be returned regardless of whether or not the image was previously the default.

NOTE: This operation ignores all elements in the request.

Deletes a specific branding image. The physical branding file will not physically be deleted immediately.

Retrieves all or part of the Trade Me category tree.

Retrieves all or part of the Trade Me category tree.

Returns a list of attribute values that match the string provided

This is a convenience method that returns ‘Used car’ child categories from Trade Me Motors.

This is a convenience method that returns all subcategories from the Motorbikes category.

Names of these subcategories represent applicable values for the ‘type’ parameter in Motorbike search.

This is a convenience method that returns jobs categories from Trade Me Jobs.

Returns the date the category tree was last changed. You can use this information to help decide whether you need to redownload the category tree.

Retrieves the list of attributes which are applicable to a specific category.

Some categories are currently unsupported (including subcategories): 350 (Real Estate), 5000 (Jobs) and 36 (Businesses for sale).

Retrieves the legal notice that the user is required to agree to before listing. Most categories do not require that the user agree to a legal notice - these categories will return an empty string.

Retrieves the default duration and the duration options that are available for listings in a specific category.

Some categories are currently unsupported (including subcategories): 350 (Real Estate), 5000 (Jobs) and 36 (Businesses for sale).

Retrieves a list of fees for a specific category.

Some categories are currently unsupported (including subcategories): 350 (Real Estate), 5000 (Jobs) and 36 (Businesses for sale).

Retrieves detailed information about a single category. This includes applicable attributes, a legal notice (for categories that have one), available listing durations, listing fees and information about whether classifieds and/or auctions are allowed to be sold within the category.

This API replaces and extends these APIs:

• Retrieve attributes for a category
• Retrieve legal notice for a category
• Retrieve listing duration options for a category
• Retrieve fees for a category

Note: this API does not require authentication, but without authentication the information returned from this API is less accurate. It is highly recommended that you authenticate when calling this API.

Retrieves detailed information about a single category. This includes applicable attributes, a legal notice (for categories that have one), available listing durations, listing fees and information about whether classifieds and/or auctions are allowed to be sold within the category.

Note: this API does not require authentication, but without authentication the information returned from this API is less accurate. It is highly recommended that you authenticate when calling this API.

Returns a three-tier locality hierarchy of regions, districts and their respective suburbs (including adjacent suburbs, if they have them). These values are used in Trade Me Property, Trade Me Jobs and Services.

Returns a three-tier locality hierarchy of regions, districts and their respective suburbs (including adjacent suburbs, if they have them). These values are used in Trade Me Property, Trade Me Jobs and Services.

Returns the districts and suburbs within the region with the given ID. These values are used in Trade Me Property, Trade Me Jobs and Services.

Returns the suburbs within a district. These values are used in Trade Me Property, Trade Me Jobs and Services.

Returns a specific suburb. These values are used in Trade Me Property, Trade Me Jobs and Services.

Returns a list of towns used in member registration. This information is displayed on member profile as the “suburb” and also on listings where the approximate location of goods is important, such as in Trade Me Motors.

Returns a list of districts and suburbs as used by TradeMe travel.

Returns a list of DVD catalogue ID numbers. You can use this list to validate the catalogue ID before listing a DVD. These ID numbers don't change very often so you should cache them and only periodically refresh them.

Returns a the list of Blu-ray catalogue ID numbers. You can use this list to validate the catalogue ID before listing a Blu-ray. These ID numbers don't change very often so you should cache them and only periodically refresh them.

Searches the Trade Me DVD catalogue for movie titles.

Searches the Trade Me Blu-ray catalogue for movie titles.

Retrieves a list of possible complaint subjects. This is used in conjunction with the send a complaint API.

Retrieves a list of possible customer support enquiry subjects. This is used in conjunction with the submit a customer support enquiry API.

Retrieves a list of all motorbike makes. Can be used when searching.

Retrieves statistics about the Trade Me website, including the number of active members and the number of active listings.

Retrieves a list of options for a search filter. The list of options may depend on the value of another filter.

Retrieves search options for a locality that matches the provided geo-location point.

Returns Top Seller Criteria

Returns a list of reasons for changing the in trade status. This is used in conjunction with the set in trade status API.

Retrieves a list of curated promotions, where each promotion links to a search.

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

Retrieves a list of your saved CVs, cover letters and/or other documents. The actual document data is not returned, only the metadata.

Retrieves the metadata and content of a specific CV, cover letter or document.

Uploads a new CV, cover letter or document.

Deletes a CV, cover letter or document.

Saves a seller to the currently authenticated user's list of favourite sellers.

Saves a search to the currently authenticated user's list of favourite searches. Can also be used to save a favourite category or seller with the option of specifying basic filters (condition, Buy Now, Pay Now) and sort order.

Saves a category to the currently authenticated user's list of favourite categories.

Retrieves the list of favourite sellers for the currently authenticated user.

Retrieves the list of favourite categories for the currently authenticated user.

Retrieves the list of favourite searches for the currently authenticated user.

Deletes a saved search, category or seller from the currently authenticated user's favourites.

Modifies the email frequency for a saved favourite.

Retrieves a list of the outstanding fixed price offers that have been offered to the currently authenticated user.

Retrieves a list of the active fixed price offers that have been made by the currently authenticated user.

Only active offers are returned. A fixed price offer is active if it has not expired, has not been accepted and has not been rejected by all participants.

Accepts or rejects a fixed price offer.

Makes a fixed price offer for an auction to the specified members. The auction must have finished closing and must have been in the closed state for less than 45 days.

Withdraws an offer that is current and not expired, accepted or rejected by all users.

Returns a list of members you can make a fixed price offer to for a particular auction.

Get cards

Retrieves a six month summary of a job agent's activity

Retrieves a report of the job agent's listings

Retrieves companies for the currently logged in member

Creates a company for the currently logged in member, or returns their existing company if they already have one

This method is to retrieve a salary suggestion for the given listing details

Retrieves paginated set of positions for a member or company

Retrieves a position

Creates a job Position

Relists or lists a similar position as a child of the specified position

Updates an existing job position

Tracking the listing process

Returns a list of valid salary options.

Returns a list of valid hourly rates.

Returns a list of pay types

Returns a list of Employment types

Returns a list of Employment duration types

Returns a set of position package tiers

Returns a list of preferred application modes

Retrieves fee information for job products including Job Packs and Volume Plans Specifically information that does not relate to purchasing a specfic listing

Retrieves fee information about a specific Job Pack

Retrieves a collection of Job Pack invoices associated with an authenticated member

Retrieves a Job Pack invoice for a member

Retrieve all enquiries made for a specific listing.

Retrieves the details of a single listing.

Retrieves a list of all the unanswered questions for all live auctions of the authenticated user.

Retrieves all of the unanswered questions for a single listing.

Post a response to a specific question on a listing. Only available to the seller of the listing. The member who asked the question will be notified.

Adds a question (or a comment) to a listing. The seller will be notified.

Sends a message to the seller of a classified via email. If possible, the listing will be added to the authenticated member's watchlist.

Sends a message to the seller of a property classified via email. If possible, the listing will be added to the authenticated member's watchlist.

Sends a message to a friend via an email.

Retrieves the hot items for the whole country or for a single region.

Retrieves the latest listed items for the whole country or for a single region.

Retrieves the items closing soon for the whole country or for a single region.

Retrieves the items with one dollar reserves for the whole country or for a single region.

Retrieves the list of current cool listings.

Retrieves items that are related to a listing.

Retrieves reviews for a listing. Currently only applicable to services listings.

Adds your review to a listing. Currently only applicable to services listings. You must be authenticated to post a review. You cannot post a review on your own listing.

Edits one your reviews. Currently only applicable to services listings.

Retrieves the list of questions (and associated answers) for a listing.

Retrieve a list of recommended listings, tailored to the current user.

Retrieves complementary items for a given listing.

Retrieves listings that are considered equivalent to a given listing

Retrieves the member ID for the member, given their nickname.

Retrieve the public profile for any member.

Retrieves feedback information for a member.

Returns the current listings for a seller. Provides data similar to that on the ‘Seller’s other listings’ page on the Trade Me website.

Returns feedback summary information for a member.

Retrieves a list of fees for a category for the currently authenticated user. These fees can differ from the standard rates if the member is a top seller or is privileged in some other way.

Retrieves full statistics and profile information for the authenticated user.

Retrieves a list of sales for the authenticated user. Multiple-quantity auctions can have multiple sales. Note that multiple items can be sold in a single sale (the QuantitySold field will contain the number of items sold).

Retrieves a list of the authenticated user's unsold listings. Multiple-quantity auctions count as unsold if there is a least one item remaining (i.e. Quantity > 0). Listings that are in the closing state are not included in the list.

Track a Courier Parcel

Update an existing Courier Parcel by Id

Delete an existing Courier Parcel by Id

Retrieves the authenticated user's active listings. Listings that are in the closing state are included in the list.

Retrieves a list of product codes and stock levels associated with the authenticated user's active listings. The results will return data from feeds and My Products.

Gets the member ledger for the authenticated user.

Returns Pay Now ledger entries for the authenticated user. If the authenticated user isn't Pay Now enabled, returns an error message.

Returns Pay Now ledger entries for a settlement into the authenticated user's bank account.

Retrieves a list of purchases for the authenticated user. Multiple-quantity auctions can be purchased multiple times.

Retrieves listings the authenticated user lost. A listing counts as "lost" if it is on the user's watchlist when it closes.

Retrieves a list of items on the authenticated user's watchlist.

Retrieve sales statistics for the authenticated user.

Retrieve sales statistics for the authenticated user.

Adds a listing to the authenticated user's watchlist. Alternatively see the Add a listing to your watchlist with options endpoint for more options.

Adds a listing to the authenticated user's watchlist with the option to control when and if an email is sent to the member warning that the auction is closing soon.

Removes a listing from the authenticated user's watchlist.

Note: an auction that the user has bid on cannot be removed.

Retrieves the Property Agent report for the authenticated user.

Retrieves a list of the outstanding fixed price offers that have been offered to the currently authenticated user. This API is identical to this one.

Accepts or rejects a fixed price offer. This API is identical to this one.

Creates or updates the note on a listing.

Retrieves the note for a listing, if there is one.

Removes the note from a listing.

Saves a status to a listing in the authenticated user's Sold Items list.

Saves a status to a listing in the authenticated user's Sold Items list.

Deletes the status from a listing in the authenticated user's Sold Items list.

Deletes the status from a listing in the authenticated user's Sold Items list.

Retrieves a list of delivery addresses for the authenticated user.

Removes a delivery address from the authenticated user's profile.

Adds a delivery address to the authenticated user's profile. The phone number, if present, is ignored.

Modifies a delivery addresses in the authenticated user's profile. The phone number, if present, is ignored.

Retrieves feedback for a single purchase, both placed and received.

Places feedback on the buyer or seller of an auction.

Modifies feedback the authenticated user has posted against a listing.

Removes feedback the authenticated user has posted against a listing.

Replies to feedback placed against a listing where the authenticated user was the seller.

Retrieves a list of all the members on the authenticated user's blacklist.

Adds a member to the authenticated user's blacklist.

Removes a member from the authenticated user's blacklist.

Retrieves the authenticated user's email preferences.

Sets the authenticated user's email preferences.

Update the user's email address.

Refunds a Pay Now payment where the authenticated user is the seller.

Note that this API currently only works if the auction closed less than 45 days ago. If you need a refund for an auction that is older than this, please contact cusomter support.

Clears the authenticated member's saved credit card information.

Hides a listing from the won items list.

Hides a listing from the lost items list.

Hides a listing from the sold items list.

Hides a listing from the unsold items list.

Submits a new enquiry message to Trade Me customer support.

Retrieves your payment instructions template. The payment instructions template affects the behaviour of listings with the SendPaymentInstructions flag set. Specifically if a listing with that flag sells, the buyer will be sent a payment instructions email that contains the text of your payment instructions template and the buyer can view the payment instructions from the Trade Me website, mobile apps or third-party tools.

Updates your payment instructions template. If you don't have a payment instructions template, it will be created. The payment instructions template affects the behaviour of listings with the SendPaymentInstructions flag set. Specifically if a listing with that flag sells, the buyer will be sent a payment instructions email that contains the text of your payment instructions template and the buyer can view the payment instructions from the Trade Me website, mobile apps or third-party tools. Note that buyers see the payment instructions as they were at the time of the sale; if you update the template it will only affect new sales.

Removes your payment instructions template.

Sends payment instructions to the winner of an auction. This will send an email to the buyer and will make the payment instructions available on the Trade Me website, mobile apps and third-party tools. Payment instructions can only be sent once, and cannot be sent at all if the buyer has already paid via Pay Now. You can check if payment instructions have been sent using the InvoiceId field (in the sold items API) or the PaymentInstructions field (in the listing details API). You can check if the buyer has paid using Pay Now using the IsPayNowPurchase field (in the sold items API) or the HasPaidByCreditCard field (in the listing details API).

Set whether the member is a professional trader. If they are a professional trader then their listings are protected by the Consumer Guarantees Act. See also get in trade reasons API.

Sends an email to the seller of a listing asking that they make a fixed price offer.

Sends an email to the seller of a listing asking that they relist the item.

Request address verification letter to be physically mailed to the membership

Confirm address verification by applying the code that has been physically mailed to the member

Adds the photo to the authenticated user's list of photos. These photos can be used when selling.

Our photo retention policy is as follows:

• Photos that were uploaded less than 10 days ago are not eligible for deletion.
• Photos that are used in an active listing are not eligible for deletion.
• Photos that were used in an auction that closed less than 45 days ago are not eligible for deletion.

It is recommended that a new photo be uploaded whenever you create a new listing. If you are relisting then uploading a new photo is not required, since you cannot relist a listing that closed more than 45 days ago.

Removes a photo from the authenticated user's list of photos.

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

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

Adds a photo to an auction. The currently authenticated user must be the seller.

This API can currently only add a single photo to an auction without any photos. It is recommended that photos are instead specified when creating a listing or when using the edit listing API (both APIs can handle multiple photos).

Adds the agent branding image to the authenticated user's list of agent branding images. These images can be used to enhance an agent contact details. This API method is currently available only for property agents.

These images are retained indefinitely.

Uploads and sets the member's profile image.

These images are retained indefinitely.

Removes the member's profile image

These images are retained indefinitely.

Get a collection of the different URLs for a given photo ID

Analyse the photo to check whether the photo is a logo or a photo.

Converts a photo into a search that can be executed to find listings that are similar to the given photo.

Gets the ping balance ledger for the logged in member

Performs full or partial refunds against a Ping purchase. Can be called multiple times for partial amounts.

Retrieve a list of a property listings for office user, with some basic statistics for This endpoint is available for all Trademe partner API accounts however is rate limited to 100 calls per hour per consumer

Returns listing statistics for all current listings listed by the office, including a break up by day and suburb.

Retrieves the counts for listing statistics from homes

Retrieve a list of a property agent's live listings, with some basic statistics for the agent's listings and their office's listings. This endpoint is available for all Trademe partner API accounts however is rate limited to 100 calls per hour per consumer

Get map dots for a given search request

Update renti status of the member. Member will be inferred from context.

Retrieve renti status of the logged in member. Member will be inferred from context.

Allows you to search for listings on Trade Me by category, by keywords or a combination of these two. The result set can be filtered by a variety of properties, including availability of Buy Now, Pay Now, item condition or seller.

Parameters listed below apply to all categories. Additional parameters are available for certain categories (for example, category 3405, digital cameras). Use the return_metadata parameter in combination with the category parameter to retrieve information about the available parameters.

This API is not recommended to search for Residential property as some categories will be excluded unless specified. To search for Residential property use the Residential Search API.

Performs a filtered keyword search in the Used cars section of Trade Me Motors.

Performs a filtered keyword search in the boats section of Trade Me Motors. Use the optional parameters to narrow down the items returned in the response.

Performs a filtered keyword search in the Motorbikes section of Trade Me Motors.

Performs a search in the residential property section of Trade Me Property.

Performs a search in New Homes of Trade Me Property

Performs a search in the rental property section of Trade Me Property.

Performs a search in the commercial property section of Trade Me Property.

Performs a search in the leased commercial property section of Trade Me Property.

Performs a search in the rural property section of Trade Me Property.

Performs a search in the lifestyle property section of Trade Me Property.

Performs a search in the retirement village section of Trade Me Property.

Performs a search within the Flatmates Wanted category.

Performs a search in the open home section of Trade Me Property.

Performs a search in Trade Me Jobs.

Performs a search within the list of registered stores.

Returns up to three collections of search suggestions all based on the passed in search term: Autosuggestions - suggestions based on similar search terms popular with the Trade Me community Recent searches - suggestions based on previous searches the logged in member has performed Category suggestions - suggestions based on categories similar to the passed in search term.

Modifies the user's search suggestion settings.

Clear any or all recent searches recorded against the user's profile.

Retrieve the recent searches for the logged in member.

Delete a single recent search.

Retrieve price grouping data representing the price distribution of listings retrieved from a given search query. Intended to be rendered as a histogram.

Performs a search in the residential section of Trade Me Property for listings in nearby suburbs with an active SRP Recommendations listing extra

Performs a search in the residential section of Trade Me Property for listings in nearby suburbs with an active HP Recommendations listing extra

Starts a new auction or classified.

You should call the category details API to determine approximate fees, attribute metadata, the legal notice, listing durations and more. The fees API can be used to determine exact fees. The member profile API also contains some relevant information.

Listing services (category 9334) is currently not supported via the API. Listing properties (category 350) and businesses for sale (category 36) is supported, but only for members who are registered property or rental agents.

Determines if a listing request is valid. Even if the request is valid, a new listing is not created.

Returns a breakdown of the fees that will be charged for a listing, without actually creating the listing.

Returns a breakdown of the fees that will be charged for editing a listing, without actually editing anything.

Returns a breakdown of the fees that will be charged for relisting a listing, without actually relisting anything.

Returns a breakdown of the fees that will be relisting a listing with edits, without actually relisting anything.

Returns the fees that will be charged for withdrawing a listing. An error is reported if the listing cannot be withdrawn.

Returns an estimate of the success fees that will be charged for a listing if it were sold at the given sale price

Edit an auction or classified that you have created. The listing must be active.

We recommend you call Retrieve the details of a single listing to populate the details of your edit listing request with any default values you are not changing. Any omitted values are treated as having been edited to a default value.

You will need to resubmit the complete sell form as used when you created the listing but with the fields you wish to edit modified.

Request format will error if fields are locked and cannot be edited.

Editing services (category 9334) is currently not supported via the API. Editing properties (category 350) and businesses for sale (category 36) is supported, but only for members who are registered property or rental agents.

Not all types of edits are currently supported. For example, attempting to move a motors listing into a general category is not supported and will fail.

Withdraw a listing from Trade Me for either being sold or unsold.

Extends the duration of an active classified listing.

The resulting expiry date of the listing will be the current date and time plus the category-specific extension period. Extension periods are currently either 14 or 21 days. This API is currently supported for classifieds in the following categories: Trade Me Property, Trade Me Motors and Businesses for Sale.

Relist an item that has expired. Relists an item without modifying editable fields.

Relist copies all data from original listing and applies them to the new listing. The only exceptions are where there are default durations that are applied on relisted items.

Some categories are currently unsupported (including subcategories): 98 (Livestock), 1349 (Horses).

Relist an item that has expired, with altered listing details.

Mostly equivalent to relisting and then editing the resulting listing, but are some differences:

• The email that gets sent out to watchers will contain the updated details.
• If you remove a promotion using this API then you will not be charged for that promotion.

This API has the same limits in terms of what you can change as the edit API.

Sell similar from an existing or expired auction or classified. Creates a new listing without modifying editable fields.

Sell similar copies all data from original listing and applies them to the new listing. The only exceptions are where there are default durations that are applied on sell similar items.

Some categories are currently unsupported (including subcategories): 98 (Livestock), 1349 (Horses).

Removes the leading bid from an auction. To remove a bid, you must be the seller of the auction.

Retrieves the details of a single listing, in a format suitable for editing. This API only works if you are the seller of the listing.

Promote a listing with a Temporal (time based) Extra

Create a draft listing for use in the sell process

Update an existing saved draft listing

Delete an existing saved draft listing

Get all saved draft listings for member

Get a single saved draft listing for member

Retrieves the selling preferences of the authenticated member

Updates the selling preferences of the authenticated member

Retrieves jobs dynamic pages directory.

Gets the list of SEO links for the Property search

Gets the list of SEO links for the Motors search

Retrieves internal links for the Property homepage.

Retrieves internal links for the Motors homepage.

Retrieves internal links and seo content for the Jobs homepage.

Retrieves internal links and seo content for the homepages of the property vertical.

Retrieves internal links and seo content for the homepages of the motors vertical.

Retrieves seo content for the homepage of the marketplace vertical.

Retrieves menu links for job homepage.

Retrieves a list of valid shipping regions to be used when creating a Shipping Template.

Adds a Shipping Template and related options.

Retrieves a list of valid Carriers to be used when creating a Shipping Template.

Retrieves a list of Carrier Products from the provided Carrier id.

Retrieves a summary of all shipping templates for the user. This summary is shallow and excludes nested objects i.e.: ShippingOptions are not included. Use String) to retrieve a fully expanded ShippingTemplate.

Retrieves the details of a single shipping template.

Updates the shipping template with the given ID.