Pricefinder Names API
The names API from Pricefinder — 3 operation(s) for names.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/pricefinder-names-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Pricefinder Names API
version: 1.13.1
contact:
name: Pricefinder
license:
name: Terms and Conditions
url: https://www.domain.com.au/group/api-terms-and-conditions/
description: 'Operations tagged names across 2 of this provider''s published API definitions: pricefinder-api-swagger.json, pricefinder-api-swagger.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /v1
tags:
- name: names
paths:
/names:
get:
tags:
- names
description: "Search for sales by owner and vendor name, as well as properties by owner name. The surname parameter can also be used to search for company/entity name.\n \n Required Parameters:\n <ul>\n <li>Each request requires a state or a suburb_id.</li>\n <li>Each request requires a surname/</li>\n <li>If a suburb id is not supplied, then a given name is required.</li>\n <ul>"
operationId: names
parameters:
- name: area_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: area_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: given_name
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: limit
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 100
- name: match_method
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- startswith
- exact
default: startswith
- name: max_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: postcode
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: property_id
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: property_type
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- house
- unit
- vacant
- commercial
- industrial
- land
- rural
- retail
- office
- other
- name: state
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
enum:
- QLD
- NSW
- VIC
- WA
- NT
- ACT
- SA
- TAS
- name: suburb_id
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: surname
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NameSearchResults'
servers:
- url: /v1
/names/properties:
get:
tags:
- names
description: "Search for properties by owner name. The surname parameter can also be used to search for company/entity name.\n \n Required Parameters:\n <ul>\n <li>Each request requires a state or a suburb_id.</li>\n <li>Each request requires a surname/</li>\n <li>If a suburb id is not supplied, then a given name is required.</li>\n <ul>"
operationId: namesProperties
parameters:
- name: area_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: area_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: given_name
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: limit
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 100
- name: match_method
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- startswith
- exact
default: startswith
- name: max_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: postcode
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: property_id
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: property_type
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- house
- unit
- vacant
- commercial
- industrial
- land
- rural
- retail
- office
- other
- name: state
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
enum:
- QLD
- NSW
- VIC
- WA
- NT
- ACT
- SA
- TAS
- name: suburb_id
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: surname
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NameSearchResults'
servers:
- url: /v1
/names/sales:
get:
tags:
- names
description: "Search for sales by owner and vendor name. The surname parameter can also be used to search for company/entity name.\n \n Required Parameters:\n <ul>\n <li>Each request requires a state or a suburb_id.</li>\n <li>Each request requires a surname/</li>\n <li>If a suburb id is not supplied, then a given name is required.</li>\n <ul>"
operationId: namesSales
parameters:
- name: area_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: area_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: given_name
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: limit
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 100
- name: match_method
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- startswith
- exact
default: startswith
- name: max_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: postcode
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: property_id
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: property_type
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- house
- unit
- vacant
- commercial
- industrial
- land
- rural
- retail
- office
- other
- name: state
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
enum:
- QLD
- NSW
- VIC
- WA
- NT
- ACT
- SA
- TAS
- name: suburb_id
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: surname
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NameSearchResults'
servers:
- url: /v1
components:
schemas:
SensitivePrice:
type: object
properties:
display:
type: string
value:
type: number
format: double
rawValue:
type: number
format: double
withheld:
type: boolean
OwnershipSummary:
type: object
properties:
names:
type: string
ownerOccupied:
type: boolean
ownerAddress:
type: string
ListingStatus:
type: object
properties:
historic:
type: boolean
underOffer:
type: boolean
listingStatus:
type: string
Phone:
type: object
properties:
surname:
type: string
initials:
type: string
address:
$ref: '#/components/schemas/Address'
number:
type: string
doNotCall:
type: boolean
doNotCallWashDate:
type: string
format: date-time
SuburbIdentifier:
type: object
properties:
id:
type: string
_self:
type: string
Sale:
type: object
properties:
id:
type: integer
format: int64
disclaimer:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
price:
$ref: '#/components/schemas/SensitivePrice'
listingHistory:
$ref: '#/components/schemas/SaleListingHistory'
saleDate:
$ref: '#/components/schemas/SensitiveDate'
settlementDate:
$ref: '#/components/schemas/SensitiveDate'
contractDate:
$ref: '#/components/schemas/SensitiveDate'
image:
$ref: '#/components/schemas/ImageIdentifier'
property:
$ref: '#/components/schemas/PropertyIdentifier'
street:
$ref: '#/components/schemas/StreetIdentifier'
suburb:
$ref: '#/components/schemas/SuburbIdentifier'
propertyType:
type: string
saleType:
type: string
agency:
$ref: '#/components/schemas/Agency'
agent:
$ref: '#/components/schemas/Agent'
location:
$ref: '#/components/schemas/Point'
metadata:
$ref: '#/components/schemas/SaleMetadata'
address:
$ref: '#/components/schemas/Address'
alternativeAddresses:
type: array
items:
$ref: '#/components/schemas/Address'
propertyFeatures:
$ref: '#/components/schemas/ExtendedPropertyFeatures'
landDetails:
$ref: '#/components/schemas/LandDetails'
rpd:
type: string
dealingNumber:
type: string
streetDisplay:
type: string
lowAskPrice:
type: integer
format: int64
highAskPrice:
type: integer
format: int64
extra:
$ref: '#/components/schemas/SearchExtra'
saleParticipants:
$ref: '#/components/schemas/SaleParticipantsSummary'
_self:
type: string
Agency:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
phoneNumber:
type: string
Property:
type: object
properties:
id:
type: integer
format: int64
matchlevel:
type: string
enum:
- suburb
- street
- property
location:
$ref: '#/components/schemas/Point'
parent:
type: boolean
disclaimer:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
address:
$ref: '#/components/schemas/Address'
features:
$ref: '#/components/schemas/ExtendedPropertyFeatures'
alternativeAddresses:
type: array
items:
$ref: '#/components/schemas/Address'
landDetails:
$ref: '#/components/schemas/LandDetails'
image:
$ref: '#/components/schemas/ImageIdentifier'
map:
$ref: '#/components/schemas/PropertyMapIdentifier'
street:
$ref: '#/components/schemas/StreetIdentifier'
suburb:
$ref: '#/components/schemas/SuburbIdentifier'
type:
type: string
rpd:
type: string
marketStatus:
$ref: '#/components/schemas/MarketStatus'
lastModified:
type: string
format: date-time
owners:
$ref: '#/components/schemas/OwnershipSummary'
ownership:
$ref: '#/components/schemas/OwnershipSummary'
lastSale:
$ref: '#/components/schemas/Sale'
recentListing:
$ref: '#/components/schemas/Listing'
recentRental:
$ref: '#/components/schemas/Listing'
extra:
$ref: '#/components/schemas/SearchExtra'
phoneNumbers:
type: array
items:
$ref: '#/components/schemas/Phone'
_self:
type: string
PropertyMapIdentifier:
type: object
properties:
id:
type: integer
format: int64
_self:
type: string
Message:
type: object
properties:
code:
type: integer
format: int64
text:
type: string
MarketStatus:
type: object
properties:
status:
type: string
recentlySold:
type: boolean
recentlyForSale:
type: boolean
recentlyForRent:
type: boolean
forSale:
type: boolean
forRent:
type: boolean
likelyToList:
type: boolean
lastMarketEvent:
$ref: '#/components/schemas/MarketStatusEventObject'
ImageIdentifier:
type: object
properties:
id:
type: integer
format: int64
_self:
type: string
SensitiveDate:
type: object
properties:
display:
type: string
value:
type: string
format: date-time
rawValue:
type: string
format: date-time
ListingIdentifier:
type: object
properties:
id:
type: integer
format: int64
rental:
type: boolean
_self:
type: string
Point:
type: object
properties:
lat:
type: number
format: double
lon:
type: number
format: double
NameSearchResults:
type: object
properties:
disclaimer:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
sales:
type: array
items:
$ref: '#/components/schemas/Sale'
properties:
type: array
items:
$ref: '#/components/schemas/Property'
SearchExtra:
type: object
properties:
distance:
type: number
format: double
nameMatchType:
type: string
matchedName:
type: string
AgencyIdentifier:
type: object
properties:
id:
type: integer
format: int64
Address:
type: object
properties:
street:
type: string
unit:
type: string
level:
type: string
lot:
type: string
streetNumber:
type: string
streetAddress:
type: string
locality:
type: string
streetLocation:
type: string
state:
type: string
postcode:
type: string
countryCode:
type: string
streetName:
type: string
streetSuffix:
type: string
streetType:
type: string
lga:
type: string
ListingListingHistory:
type: object
properties:
originalPrice:
$ref: '#/components/schemas/SensitivePrice'
originalPricePercentChange:
$ref: '#/components/schemas/SensitiveChange'
daysOnMarket:
type: integer
format: int64
lowAskPrice:
type: integer
format: int64
highAskPrice:
type: integer
format: int64
StreetIdentifier:
type: object
properties:
id:
type: string
SensitiveChange:
type: object
properties:
display:
type: string
value:
type: number
format: double
rawValue:
type: number
format: double
Listing:
type: object
properties:
id:
type: integer
format: int64
rental:
type: boolean
disclaimer:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
agents:
type: array
items:
$ref: '#/components/schemas/Agent'
agencies:
type: array
items:
$ref: '#/components/schemas/Agency'
price:
$ref: '#/components/schemas/SensitivePrice'
listingHistory:
$ref: '#/components/schemas/ListingListingHistory'
startDate:
$ref: '#/components/schemas/SensitiveDate'
image:
$ref: '#/components/schemas/ImageIdentifier'
property:
$ref: '#/components/schemas/PropertyIdentifier'
street:
$ref: '#/components/schemas/StreetIdentifier'
suburb:
$ref: '#/components/schemas/SuburbIdentifier'
location:
$ref: '#/components/schemas/Point'
propertyLegalDescription:
type: string
propertyType:
type: string
type:
type: string
status:
$ref: '#/components/schemas/ListingStatus'
endDate:
$ref: '#/components/schemas/SensitiveDate'
lastModified:
$ref: '#/components/schemas/SensitiveDate'
propertyFeatures:
$ref: '#/components/schemas/ExtendedPropertyFeatures'
address:
$ref: '#/components/schemas/Address'
originalListingAddress:
$ref: '#/components/schemas/Address'
landDetails:
$ref: '#/components/schemas/LandDetails'
extra:
$ref: '#/components/schemas/SearchExtra'
_self:
type: string
SaleParticipantsSummary:
type: object
properties:
vendorsSummary:
type: string
purchasersSummary:
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pricefinder/refs/heads/main/openapi/pricefinder-names-api-openapi.yml