> ## Documentation Index > Fetch the complete documentation index at: https://qwady.wiki/llms.txt > Use this file to discover all available pages before exploring further. # Get Usage > Returns the caller's current billing-period quota usage. Authenticated and rate-limited, but does NOT count against your monthly quota. Without an API key it returns anonymous free-tier (IP-bucketed) usage; with a key it returns that key's usage. **Tier:** Free+ ## OpenAPI ````yaml GET /usage openapi: 3.1.0 info: title: Borough API description: > NYC Real Estate Data API: structured access to rental and sale listings, building details, neighborhood data, and market statistics. ## Authentication All authenticated endpoints require a `Bearer` token in the `Authorization` header: ``` Authorization: Bearer BOROUGH- ``` License keys are provisioned automatically when you subscribe via [Polar.sh](https://polar.sh/qwady-solutions-llc/portal). Free-tier endpoints (search, areas, market, and photos) work without authentication but are tracked per IP and subject to IP-based rate limits of 10 requests per minute. The health check endpoint remains fully public. ## Rate Limits | Tier | Requests/min | Requests/month | Max perPage | |----------|-------------|----------------|-------------| | Free | 10 | 100 | 10 | | Starter | 30 | 5,000 | 50 | | Pro | 60 | 25,000 | 500 | | Business | 120 | 100,000 | 500 | Tiered API responses include the `X-RateLimit-Limit` and `X-Quota-*` headers, plus an `X-Request-Id` header (UUID v4) for request tracing and debugging. Note that 429 responses additionally carry a `Retry-After` header and an `error.retryAfter` value in the body. The health check remains fully public and does not carry quota headers. ## Data Freshness Freshness-aware JSON data responses include a `meta.dataAge` field (ISO 8601) indicating when the underlying data was last scraped, and a `meta.source` field indicating how the data was served (`cached`, `stale`, or `live`). Public cache cadence varies by dataset: rental search refreshes every 6h, sale search every 8h, listing detail sweeps every 12h, buildings every 3 days, broadband enrichment monthly, and market snapshots daily at 05:00 UTC. Paid tiers use freshness thresholds to trigger background refreshes when cached data exceeds the threshold for that route family. | Tier | Search Threshold | Listing Threshold | Building Threshold | |----------|------------------|-------------------|--------------------| | Starter | 8h | 30min | 6h | | Pro | 8h | 15min | 3h | | Business | 8h | 10min | 2h | ## Photo URLs Listing and building responses include photo keys (32-character hex hashes). Use the Borough proxy for first-party image URLs: ``` https://borough.qwady.app/v1/photos/{key} ``` Supported sizes: ``` large_800_400 (default), medium_500_250 ``` version: 1.0.0 contact: name: Qwady Solutions LLC url: https://borough.qwady.app email: api@qwady.com license: name: Proprietary url: https://borough.qwady.app/terms servers: - url: https://borough.qwady.app/v1 description: Production security: - BearerAuth: [] tags: - name: Search description: Search rental and sale listings with filters - name: Property description: Individual listing details and price history - name: Building description: Building information, amenities, and active listings - name: Areas description: Neighborhoods, boroughs, and geographic boundaries - name: Market description: Market snapshots, trends, and area comparisons - name: Webhooks description: Webhook subscriptions for listing change notifications - name: Watchers description: Persistent watchers for real-time listing, building, and search monitoring - name: Streaming description: Server-Sent Events for live data and watcher changes - name: Utility description: Health checks and internal endpoints paths: /usage: get: tags: - Utility summary: Current quota usage description: > Returns the caller's current billing-period quota usage. Authenticated and rate-limited, but does NOT count against your monthly quota. Without an API key it returns anonymous free-tier (IP-bucketed) usage; with a key it returns that key's usage. **Tier:** Free+ operationId: getUsage responses: '200': description: Current usage breakdown content: application/json: schema: type: object properties: data: type: object properties: tier: type: string enum: - FREE - STARTER - PRO - BUSINESS - INTERNAL quota: type: integer used: type: integer remaining: type: integer overageLimit: type: - integer - 'null' description: >- Hard limit including overage headroom (paid tiers); null otherwise. percentUsed: type: - integer - 'null' periodStart: type: - string - 'null' format: date-time periodEnd: type: - string - 'null' format: date-time meta: type: object properties: dataAge: type: - string - 'null' source: type: string example: data: tier: STARTER quota: 5000 used: 1234 remaining: 3766 overageLimit: 15000 percentUsed: 25 periodStart: '2026-07-01T00:00:00.000Z' periodEnd: '2026-08-01T00:00:00.000Z' meta: dataAge: null source: live '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' security: - BearerAuth: [] - {} components: responses: RateLimited: description: Rate limit exceeded headers: Retry-After: schema: type: integer description: Seconds until rate limit resets content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: RATE_LIMIT_EXCEEDED message: Rate limit exceeded. Retry after 32 seconds. status: 429 retryAfter: 32 InternalError: description: Unexpected server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: INTERNAL_ERROR message: >- An unexpected error occurred. Please retry or contact support with the X-Request-Id. status: 500 schemas: ErrorResponse: type: object properties: error: type: object required: - code - message - status properties: code: type: string enum: - INVALID_PARAMS - MISSING_API_KEY - INVALID_API_KEY - EXPIRED_API_KEY - TIER_RESTRICTED - QUOTA_EXCEEDED - NOT_FOUND - WEBHOOK_NOT_FOUND - RATE_LIMIT_EXCEEDED - INTERNAL_ERROR - UPSTREAM_ERROR - SERVICE_DISABLED message: type: string status: type: integer retryAfter: type: - integer - 'null' description: Seconds to wait before retrying (for 429 responses) securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: BOROUGH- description: 'Polar.sh license key. Format: `BOROUGH-`' ````