-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapis.yml
More file actions
440 lines (440 loc) · 18.1 KB
/
Copy pathapis.yml
File metadata and controls
440 lines (440 loc) · 18.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
aid: rea-group
url: https://raw.githubusercontent.com/api-evangelist/rea-group/refs/heads/main/apis.yml
name: REA Group
kind: company
description: REA Group Limited is an ASX-listed (ASX:REA) digital real estate advertising
business headquartered in Melbourne, Australia and majority-owned by News Corp. It
operates realestate.com.au and realcommercial.com.au, the property data and analytics
brand PropTrack, the Mortgage Choice broking network, and REA India (Housing.com,
PropTiger, and Makaan). REA Group's public developer surface is delivered through
PropTrack, whose developer portal publishes nine OpenAPI 3.1 documents covering 32
operations - OAuth token issuance, address matching and suggestion, property summary,
attributes, planning, tenure, listings and transactions, automated valuations (AVM
Sale, Rent, Plus and Pro), PDF valuation and property reports, suburb-level market
history, supply and demand, auction results and demographics, plus a Disclaimers API
that serves the attribution text PropTrack contractually requires alongside its data.
Every service also publishes a live, unauthenticated Stoplight mock server, so the
contract can be exercised before a commercial agreement is signed. The APIs are
documented publicly but are partner-gated - access requires a commercial agreement
arranged through an Account Manager, and calls are authenticated with OAuth 2.0
client credentials exchanged for a one-hour JWT bearer token at data.proptrack.com.
Alongside PropTrack, REA Group runs the realestate.com.au Partner Portal
(partner.realestate.com.au), the integration surface for real estate agencies and
their CRM / software providers to publish for-sale and for-rent listings onto
realestate.com.au and realcommercial.com.au and to receive buyer and renter
enquiries. Listing distribution uses REAXML, REA's long-standing industry-standard
XML property feed (schema published at reaxml.realestate.com.au), which the majority
of Australian agency CRMs implement, with partner onboarding, API credentials
(Client ID + secret) and enquiry delivery managed through the partner portal.
accessModel:
pricing: contract
onboarding: partner-gated
trial: true
try_now: true
public: false
label: Partner-gated, commercial agreement required; public mock servers
confidence: high
source:
- https://developer.proptrack.com.au/docs/apis/api-trials
- https://developer.proptrack.com.au/docs/apis/how-to-authenticate
- plans/rea-group-plans.yml
- sandbox/rea-group-sandbox.yml
generated: '2026-07-27'
method: searched
note: >-
Corrects the earlier derived value of "self-serve". There is no self-serve
signup: credentials are issued by an Account Manager under a commercial
agreement. try_now is true because every service publishes an unauthenticated
Stoplight mock server, and trial is true because a quota- and expiry-bounded
trial programme is documented.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/rea-group.png
tags:
- Real Estate
- Property Data
- Valuations
- AVM
- Market Insights
- Listings
- Transactions
- Address Matching
- REAXML
- Partner Portal
- PropTech
- Australia
created: '2026-07-20'
modified: '2026-07-27T12:00:00Z'
specificationVersion: '0.19'
apis:
- aid: rea-group:proptrack-oauth-api
name: PropTrack OAuth 2.0 Token API
tags:
- Authentication
- OAuth
- Security
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/how-to-authenticate
baseURL: https://data.proptrack.com
properties:
- url: openapi/rea-group-oauth-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/how-to-authenticate
type: Documentation
- url: https://developer.proptrack.com.au/docs/apis/authentication
type: APIReference
- url: https://stoplight.io/mocks/proptrack/apis/70243931
type: Sandbox
description: >-
The OAuth 2.0 client credentials token service. POST /oauth2/token with the
partner api_key and api_secret Base64-encoded as HTTP Basic returns a JWT
access token with a 3600 second TTL, presented as a Bearer token on every
other PropTrack operation. Credentials in form parameters are not supported.
- aid: rea-group:proptrack-address-api
name: PropTrack Address API
tags:
- Address
- Geocoding
- Matching
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/address
baseURL: https://data.proptrack.com/api/v2
properties:
- url: openapi/rea-group-address-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/address
type: Documentation
- url: https://developer.proptrack.com.au/docs/apis/home
type: DeveloperPortal
- url: https://stoplight.io/mocks/proptrack/apis/67669714
type: Sandbox
description: >-
Address match and address suggest. Resolves free-text or partial Australian
addresses to a canonical propertyId and gpid with a matchScore - the entry
point for almost every PropTrack workflow. Structured component-wise address
match is documented as coming soon.
- aid: rea-group:proptrack-properties-api
name: PropTrack Properties API
tags:
- Property Data
- Valuations
- AVM
- Real Estate
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/properties
baseURL: https://data.proptrack.com
properties:
- url: openapi/rea-group-properties-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/properties
type: Documentation
- url: https://developer.proptrack.com.au/docs/apis/home
type: DeveloperPortal
- url: https://stoplight.io/mocks/proptrack/apis/67669715
type: Sandbox
description: >-
The largest PropTrack service - 15 operations spanning property summary,
attributes, listings, planning and zoning, tenure type, transactions and
property search (summaries and map geopoints) under /api/v2, plus the whole
Automated Valuation Model surface under /api/v1: sale and rent valuations by
address string or propertyId, each as an enquiry or origination request, and
the AVM Plus (sale + rent) and AVM Pro (sale + rent + environmental hazards)
combined products. The valuation operations are billable, side-effecting
orders with no idempotency contract.
- aid: rea-group:proptrack-listings-api
name: PropTrack Listings API
tags:
- Listings
- Search
- Geospatial
- Real Estate
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/listings
baseURL: https://data.proptrack.com/api/v2
properties:
- url: openapi/rea-group-listings-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/listings
type: Documentation
- url: https://developer.proptrack.com.au/docs/apis/home
type: DeveloperPortal
- url: https://stoplight.io/mocks/proptrack/apis/160758630
type: Sandbox
description: >-
Listing detail by listingId plus two cursor-paginated search shapes - point
and radius, and suburb and postcode - exposing for-sale and for-rent listing
data from realestate.com.au and realcommercial.com.au.
- aid: rea-group:proptrack-transactions-api
name: PropTrack Transactions API
tags:
- Transactions
- Sold Data
- Search
- Geospatial
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/transactions
baseURL: https://data.proptrack.com/api/v2
properties:
- url: openapi/rea-group-transactions-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/transactions
type: Documentation
- url: https://developer.proptrack.com.au/docs/apis/home
type: DeveloperPortal
- url: https://stoplight.io/mocks/proptrack/apis/205281044
type: Sandbox
description: >-
Sold transaction search by point and radius and by suburb and postcode,
cursor-paginated. On trial agreements, transactions sourced from the Victorian
Valuer-General are withheld while agent-advised transactions remain available.
- aid: rea-group:proptrack-market-api
name: PropTrack Market API
tags:
- Market Insights
- Analytics
- Suburb Trends
- Demographics
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/market
baseURL: https://data.proptrack.com/api/v2
properties:
- url: openapi/rea-group-market-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/market
type: Documentation
- url: https://developer.proptrack.com.au/docs/apis/home
type: DeveloperPortal
- url: https://stoplight.io/mocks/proptrack/apis/99896681
type: Sandbox
description: >-
Suburb-level market statistics - sale price history, rent history, supply and
demand, auction results and demographics. Keyed by geography (searchType plus
state, postcode or suburb) rather than by propertyId, so it is the one branch
of the surface that does not join to the property graph.
- aid: rea-group:proptrack-reports-api
name: PropTrack Reports API
tags:
- Reports
- Valuations
- PDF
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/reports
baseURL: https://data.proptrack.com/api/v1
properties:
- url: openapi/rea-group-reports-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/reports
type: Documentation
- url: https://developer.proptrack.com.au/docs/apis/home
type: DeveloperPortal
- url: https://stoplight.io/mocks/proptrack/apis/181515791
type: Sandbox
description: >-
Renders an ordered AVM valuation as a PDF by valuationId, and orders a
standalone property report. Rate limited to 25 requests per second and the
only operations besides AVM that document a 504 Gateway Timeout.
- aid: rea-group:proptrack-disclaimers-api
name: PropTrack Disclaimers API
tags:
- Disclaimers
- Attribution
- Branding
- Compliance
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/disclaimersbranding
baseURL: https://data.proptrack.com/api/v1
properties:
- url: openapi/rea-group-disclaimers-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/disclaimersbranding
type: Documentation
- url: https://stoplight.io/mocks/proptrack/apis/723134185
type: Sandbox
description: >-
Serves the attribution and disclaimer text PropTrack contractually requires be
displayed wherever its data is rendered, plus the associated branding rules.
Fetching it rather than hardcoding is the documented expectation, since the
required wording changes.
- aid: rea-group:proptrack-upcoming-api
name: PropTrack Upcoming APIs (Schools)
tags:
- Education
- Schools
- Roadmap
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://developer.proptrack.com.au/docs/apis/coming-soon
baseURL: https://data.proptrack.com/api/v2
properties:
- url: openapi/rea-group-coming-soon-openapi.yml
type: OpenAPI
- url: https://developer.proptrack.com.au/docs/apis/coming-soon
type: Documentation
- url: https://stoplight.io/mocks/proptrack/apis/639882521
type: Sandbox
description: >-
Documented but not yet released. A nearby-education-facilities endpoint keyed
by propertyId, published ahead of availability on the Coming Soon page - the
closest thing PropTrack publishes to a roadmap.
- aid: rea-group:realestate-listing-feed-reaxml
name: realestate.com.au Listing Feed (REAXML)
tags:
- Listings
- Feed
- REAXML
- Real Estate
- Australia
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://partner.realestate.com.au/
baseURL: https://reaxml.realestate.com.au
properties:
- url: https://partner.realestate.com.au/
type: DeveloperPortal
- url: https://reaxml.realestate.com.au/propertyList.dtd
type: Schema
description: REA Group's REAXML listing feed - the long-standing industry-standard
XML property schema used by Australian agency CRMs to publish residential and
commercial for-sale and for-rent listings onto realestate.com.au and
realcommercial.com.au. Registered data/interconnect providers upload listing
payloads (create/update/withdraw/sold) validated against the published propertyList
DTD. Access is gated through the realestate.com.au Partner Portal and requires an
approved uploader agreement with API credentials (Client ID + secret).
- aid: rea-group:realestate-partner-portal
name: realestate.com.au Partner Portal
tags:
- Partner
- Onboarding
- Enquiries
- Real Estate
- Australia
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://partner.realestate.com.au/
baseURL: https://partner.realestate.com.au
properties:
- url: https://partner.realestate.com.au/
type: DeveloperPortal
description: The realestate.com.au Partner Portal is REA Group's integration surface
for agencies and their software / CRM providers - covering partner onboarding, API
credential management (Client ID + API secret key issued in the REA Portal), listing
distribution configuration, and delivery of buyer and renter enquiries and leads
back to partner systems. Authenticated via REA Group's OAuth identity service;
access is partner-gated and requires an approved commercial agreement.
common:
- type: Website
url: https://www.rea-group.com/
- type: Documentation
url: https://developer.proptrack.com.au/docs/apis/home
- type: DeveloperPortal
url: https://developer.proptrack.com.au/
- type: APIReference
url: https://developer.proptrack.com.au/docs/apis/guide
- type: GettingStarted
url: https://developer.proptrack.com.au/docs/apis/how-to-authenticate
- type: PartnerPortal
url: https://partner.realestate.com.au/
- type: Schema
url: https://reaxml.realestate.com.au/propertyList.dtd
- type: GitHubOrganization
url: https://github.com/realestate-com-au
- type: LinkedIn
url: https://www.linkedin.com/company/rea-group/
- type: X
url: https://twitter.com/REA_Group
- type: YouTube
url: https://www.youtube.com/channel/UCfLcFXAN3pjad2aCzUNhUaA
- type: Blog
url: https://www.rea-group.com/about-us/news-and-insights/
- type: Support
url: https://www.proptrack.com.au/support/contact-support/
- type: FAQ
url: https://developer.proptrack.com.au/docs/apis/faqs
- type: SignUp
url: https://www.proptrack.com.au/contact-us
- type: PrivacyPolicy
url: https://www.rea-group.com/privacy/
- type: TermsOfService
url: https://developer.proptrack.com.au/docs/apis/terms-of-use
- type: Authentication
url: authentication/rea-group-authentication.yml
- type: Conventions
url: conventions/rea-group-conventions.yml
- type: Pagination
url: https://developer.proptrack.com.au/docs/apis/pagination
- type: RateLimits
url: rate-limits/rea-group-rate-limits.yml
- type: ErrorCatalog
url: errors/rea-group-error-codes.yml
- type: Examples
url: examples/rea-group-examples.yml
- type: DataModel
url: data-model/rea-group-data-model.yml
- type: Sandbox
url: sandbox/rea-group-sandbox.yml
- type: Plans
url: plans/rea-group-plans.yml
- type: AgentSkill
url: skills/_index.yml
- type: AgenticAccess
url: agentic-access/rea-group-agentic-access.yml
- type: Overlay
url: overlays/rea-group-security-overlay.yaml
- type: Conformance
url: conformance/rea-group-conformance.yml
- type: Lifecycle
url: lifecycle/rea-group-lifecycle.yml
- type: Roadmap
url: https://developer.proptrack.com.au/docs/apis/coming-soon
- type: WellKnown
url: well-known/rea-group-well-known.yml
- type: SecurityTxt
url: well-known/rea-group-security.txt
- type: DomainSecurity
url: security/rea-group-domain-security.yml
- type: VulnerabilityDisclosure
url: security/rea-group-vulnerability-disclosure.yml
- type: Security
url: https://www.rea-group.com/security
- type: LLMsTxt
url: llms/rea-group-llms.txt
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
x-enrichment:
date: '2026-07-27'
status: enriched
pass: local-v2
method: >-
Contract discovery against the PropTrack Stoplight workspace recovered nine
provider-published OpenAPI 3.1.0 documents (32 operations, 189 named examples)
plus thirteen documentation articles, which grounded a full artifact rebuild.
artifacts_added:
- openapi/ (9 documents, searched)
- errors/rea-group-error-codes.yml (18 codes, searched)
- rate-limits/rea-group-rate-limits.yml (16 endpoint limits, searched)
- plans/rea-group-plans.yml (searched)
- sandbox/rea-group-sandbox.yml (9 live mock servers, searched + verified)
- examples/rea-group-examples.yml (derived)
- data-model/rea-group-data-model.yml (derived)
- mcp/rea-group-mcp.yml (derived candidate, not published by provider)
- skills/ (3 skills + index, generated)
- agentic-access/rea-group-agentic-access.yml (generated)
- overlays/rea-group-security-overlay.yaml (generated)
artifacts_upgraded:
- authentication/ (unknown token URL -> full OAuth client-credentials profile)
- conventions/ (4 unknowns -> cursor pagination, error envelope, tracing header)
- lifecycle/ (added concurrent v1/v2, roadmap, verified no status page)
- conformance/ (4 standards -> 13, incl. RESO non-conformance rationale)
not_emitted:
- >-
MCPServer pointer - PropTrack publishes no MCP server. The mcp/ artifact is a
derived candidate surface only; claiming the pointer would assert a server
that does not exist.
- >-
Idempotency pointer - no idempotency key, header or safe-retry contract is
documented, and the three billable POST operations have none.
- >-
Compliance pointer - no trust centre, SOC 2 or ISO 27001 attestation is
published.
- >-
StatusPage / Deprecation pointers - verified absent, not merely unfound.
- >-
Packages / SDKs pointers - no first-party client libraries on npm or PyPI.
- >-
OAuthScopes - OAuth 2.0 is client-credentials with no published scope surface.