PropertyIndex · Schema

Usage

CompanyReal EstateDubaiProperty DataMarket Intelligence

Properties

Name Type Description
kind string
unit string
used integer Sales and rental records returned in this period. Repeated retrievals count again.
allowance integer Included records: 1,000,000 per paid billing period, or the fixed demo grant.
remaining integer Included records remaining: max(0, allowance - used). Excludes overage capacity.
hardCap boolean Always true. A response exceeding recordsRemaining is rejected in full without consuming records.
periodKey string
periodEnd stringnull
overageEnabled boolean Off by default. Requires paid-plan owner/admin opt-in and a finite monthly overage spending cap. Demos do not support overage.
overageCapMinor integer Monthly overage spending cap in fils (100 fils = AED 1).
overageRecords integer Records above the included allowance: max(0, used - allowance).
overageCostMinor integer Overage cost in fils, rounded on the billing period total: round(overageRecords / 5). Equivalent to AED 2 per 1,000 records.
recordLimit integer Effective record limit: allowance + (overageEnabled ? overageCapMinor * 5 : 0).
recordsRemaining integer Effective records remaining, including enabled overage capacity: max(0, recordLimit - used).
View JSON Schema on GitHub

JSON Schema

propertyindex-ae-usage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/propertyindex-ae/json-schema/propertyindex-ae-usage-schema.json",
  "title": "Usage",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/propertyindex-ae-openapi.json#/components/schemas/Usage",
  "type": "object",
  "required": [
    "kind",
    "unit",
    "used",
    "allowance",
    "remaining",
    "hardCap",
    "periodKey",
    "periodEnd",
    "overageEnabled",
    "overageCapMinor",
    "overageRecords",
    "overageCostMinor",
    "recordLimit",
    "recordsRemaining"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "paid",
        "demo"
      ]
    },
    "unit": {
      "type": "string",
      "const": "records"
    },
    "used": {
      "type": "integer",
      "minimum": 0,
      "description": "Sales and rental records returned in this period. Repeated retrievals count again."
    },
    "allowance": {
      "type": "integer",
      "minimum": 0,
      "description": "Included records: 1,000,000 per paid billing period, or the fixed demo grant."
    },
    "remaining": {
      "type": "integer",
      "minimum": 0,
      "description": "Included records remaining: max(0, allowance - used). Excludes overage capacity."
    },
    "hardCap": {
      "type": "boolean",
      "const": true,
      "description": "Always true. A response exceeding recordsRemaining is rejected in full without consuming records."
    },
    "periodKey": {
      "type": "string"
    },
    "periodEnd": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "overageEnabled": {
      "type": "boolean",
      "description": "Off by default. Requires paid-plan owner/admin opt-in and a finite monthly overage spending cap. Demos do not support overage."
    },
    "overageCapMinor": {
      "type": "integer",
      "minimum": 0,
      "description": "Monthly overage spending cap in fils (100 fils = AED 1)."
    },
    "overageRecords": {
      "type": "integer",
      "minimum": 0,
      "description": "Records above the included allowance: max(0, used - allowance)."
    },
    "overageCostMinor": {
      "type": "integer",
      "minimum": 0,
      "description": "Overage cost in fils, rounded on the billing period total: round(overageRecords / 5). Equivalent to AED 2 per 1,000 records."
    },
    "recordLimit": {
      "type": "integer",
      "minimum": 0,
      "description": "Effective record limit: allowance + (overageEnabled ? overageCapMinor * 5 : 0)."
    },
    "recordsRemaining": {
      "type": "integer",
      "minimum": 0,
      "description": "Effective records remaining, including enabled overage capacity: max(0, recordLimit - used)."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/propertyindex-ae-usage"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.