Aristocles Pty Ltd Usage API

openapi: 3.2.0
info:
  title: Aristocles Data Usage API
  description: 'Four Australian data APIs on one key — subscriptions, trade pricing, PBS drugs, and rental prices.


    ---


    ## Quick start


    **1. Get your API key** — register in one request:

    ```

    POST /v1/auth/register

    {"email": "you@example.com", "name": "Your Name"}

    ```

    Copy the `api_key` from the response.


    **2. Authenticate** — add your key to every request as a header:

    ```

    X-API-Key: ar_live_xxxxxxxxxxxx

    ```


    **3. Run the discovery endpoint** — returns all available slugs, example calls, and your account limits:

    ```

    GET /v1/discovery

    ```


    **4. Make your first call:**

    ```

    GET /v1/prices/netflix?country=AU

    GET /v1/trades/electrician/prices?state=NSW&country=AU

    GET /v1/pbs/metformin

    GET /v1/rental/VIC/Richmond

    ```


    ---


    ## Four data domains


    | Domain | Base path | What it covers |

    |---|---|---|

    | **Subscription Pricing** | `/v1/prices`, `/v1/services` | 50+ SaaS & streaming services: Netflix, Spotify, Adobe, etc. |

    | **Contractor Trades** | `/v1/trades` | Plumbers, electricians, painters across AU, US, UK, CA, NZ |

    | **PBS Drug Pricing** | `/v1/pbs` | 14,000+ medications on Australia''s Pharmaceutical Benefits Scheme |

    | **Rental Market** | `/v1/rental` | Median weekly rent by suburb and postcode across Australia |

    | **RBA Economic Data** | `/v1/rba` | Cash rate, AUD FX rates, CPI inflation, mortgage rates, credit aggregates |


    ---


    ## MCP Server


    All four data domains are also available as MCP tools at:

    ```

    https://api.aristocles.com.au/mcp/

    ```

    Connect any MCP-compatible AI agent (Claude, GPT, Gemini) to get structured data without writing API calls.'
  version: 2.1.0
tags:
- name: Usage
paths:
  /v1/usage:
    get:
      tags:
      - Usage
      summary: Usage Dashboard
      description: Get usage dashboard for the current API key.
      operationId: usage_dashboard_v1_usage_get
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_UsageDashboard_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ApiResponse_UsageDashboard_:
      properties:
        data:
          $ref: '#/components/schemas/UsageDashboard'
        meta:
          $ref: '#/components/schemas/Meta'
      type: object
      required:
      - data
      title: ApiResponse[UsageDashboard]
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UsageDashboard:
      properties:
        tier:
          type: string
          title: Tier
        daily_limit:
          type: integer
          title: Daily Limit
        requests_today:
          type: integer
          title: Requests Today
        remaining:
          type: integer
          title: Remaining
        endpoints:
          items:
            $ref: '#/components/schemas/EndpointUsage'
          type: array
          title: Endpoints
      type: object
      required:
      - tier
      - daily_limit
      - requests_today
      - remaining
      - endpoints
      title: UsageDashboard
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EndpointUsage:
      properties:
        endpoint:
          type: string
          title: Endpoint
        count:
          type: integer
          title: Count
      type: object
      required:
      - endpoint
      - count
      title: EndpointUsage
    Meta:
      properties:
        timestamp:
          type: string
          format: date-time
          title: Timestamp
        source:
          type: string
          title: Source
          default: aristocles-api
        version:
          type: string
          title: Version
          default: '1.0'
      type: object
      title: Meta