Account

Every API call (except obtaining a token) requires a Bearer token in the Authorization header:

Authorization: Bearer <access_token>

---

Authentication

Obtain Token

Get authentication token

post

Obtain an access token using your credentials

Body

application/x-www-form-urlencoded

usernamestringRequired

Your API username

passwordstring · passwordRequired

Your API password

Responses

200

Successful authentication

application/json

400

Invalid request

application/json

post

/v1/token

JavaScriptCurlPythonHTTP

fetch("https://api.realtrex.com/v1/token", {
  method: "POST",
  headers: {
    "Content-Type": "application/x-www-form-urlencoded"
  },
  body: new URLSearchParams({
    username: "Your API username",
    password: "Your API password"
  })
})
.then(res => res.json())
.then(console.log);

{
  "access_token": "text",
  "expires_in": 2592000,
  "type": "Bearer"
}

---

Account

Get Usage

Retrieve current API usage statistics for your account, including daily and monthly limits and consumption.

Endpoint: GET /v1/account/get_usage

Authentication: Required (Bearer token)

Response:

{
    "resources": {
        "property": {
            "name": "property",
            "daily_limit": 1000,
            "daily_usage": 10,
            "monthly_limit": 10000,
            "monthly_usage": 128
        }
    }
}

Response Fields:

• resources - Object containing usage data for each resource type (dynamic based on account access)

  • [resource_key] - Usage data for a specific resource (e.g., property)

    • name - Human-readable resource name

    • daily_limit - Maximum daily usage allowed

    • daily_usage - Requests consumed today

    • monthly_limit - Maximum monthly usage allowed

    • monthly_usage - Requests consumed this billing period

Note: The response only includes resources with usage tracking enabled for your account.

Example Request:

curl -X GET \
  https://api.realtrex.com/v1/account/get_usage \
  -H "Authorization: Bearer <access_token>"

---

Get Usage History

Retrieve historical API usage data for your account. Returns the last 60 days of usage data.

Endpoint: GET /v1/account/get_usage_history

Authentication: Required (Bearer token)

Response:

{
    "property": {
        "name": "Property Resource",
        "data": [
            {"date": "2025-10-15", "usage_count": 10},
            {"date": "2025-10-14", "usage_count": 5},
            {"date": "2025-10-13", "usage_count": 8}
        ]
    }
}

Response Fields:

• [resource_key] - Historical usage data for each resource (e.g., property)

  • name - Human-readable resource name

  • data - Array of daily usage records (last 60 days, only includes days with activity)

    • date - Date in YYYY-MM-DD format

    • usage_count - Number of requests consumed on that date

Note: The response only includes resources with usage tracking enabled for your account. The data array only contains entries for dates with activity (non-zero usage).

Example Request:

curl -X GET \
  https://api.realtrex.com/v1/account/get_usage_history \
  -H "Authorization: Bearer <access_token>"