\n Connect with us\n \n \n \n \n \n\n"
termsOfService: https://developer.proptrack.com.au/docs/apis/terms-of-use
contact:
email: https://www.proptrack.com.au/contact-us
url: https://www.proptrack.com.au/contact-us
name: PropTrack
servers:
- url: https://data.proptrack.com
tags:
- name: Oauth2
paths:
/oauth2/token:
post:
summary: /oauth2/token
description: "The token service, using OAuth 2.0, is responsible for generating and validating an authentication token.\n \nPrior to making an API request, a token needs to be generated using your assigned credentials. The token is required prior to making any API call.\n\nRefer to [How To Authenticate](https://developer.proptrack.com.au/docs/apis/how-to-authenticate) for further information."
operationId: auth-token
parameters:
- name: Authorization
in: header
description: Contains the word Basic, followed by a space and a base64-encoded(non-encrypted) string api_key:api_secret. For example, where api_key = key and api_secret = secret, then your base64-encoded Basic Header would be the below Example value.
required: true
schema:
type: string
examples:
- Basic a2V5OnNlY3JldA==
requestBody:
description: '> PropTrack does not support provision of client credentials as form parameters in the request body.'
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
grant_type:
enum:
- client_credentials
description: Should always be `client_credentials`
type: string
required:
- grant_type
examples:
Sample Request:
value:
grant_type: client_credentials
responses:
'200':
description: '
> #### Success (200)'
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
description: 'The access token (JWT)
Note: This will be used in the `Authorization` Header for all subsequent calls to the other Property Data API endpoints'
examples:
- eyJrarY0doWW9nWmJJXC9FQWlrZXNuWUk9IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI2c2QxNGVpNTVkazg1OWxjcG4yZ2tnM2JuYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoic_lLWFw
token_type:
enum:
- Bearer
description: 'The type of authentication token
Note: `Basic` will be used for the authentication token request, but all subsequent calls to the other Property Data API endpoints would use `Bearer` as the token type'
examples:
- Bearer
type: string
expires_in:
enum:
- 3600
description: 'Allowed time to live (TTL) until a new authentication token is required (measured in seconds)
Note: This will always be equal to 3,600 seconds (1 hour)'
examples:
- 3600
type: integer
required:
- access_token
- token_type
- expires_in
'401':
description: '
> #### Unauthorized (401)'
'403':
description: "\n\n> #### Forbidden (403)\n\nIf you receive an error message in the following format, it could be due to your IP address being blocked. Please contact our customer support team at support@proptrack.com for further information.\n\n``` html\n\n\n\n Access Denied\n\n\n\n Access Denied
\n\n You don't have permission to access\n \"http://data-sit.uat.proptrack.com/oauth2/token\" on this server.\n Reference #18.2ff877df.1709188434.cf2b11c\n\n\n\n```"
content: {}
servers:
- url: https://data.proptrack.com
tags:
- Oauth2