Aristocles Pty Ltd Getting Started API

openapi: 3.2.0
info:
  title: Aristocles Data Getting Started 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: Getting Started
  description: Discovery endpoint — returns all available slugs, example calls, coverage, and your account limits. Start here.
paths:
  /v1/discovery:
    get:
      tags:
      - Getting Started
      summary: Discovery Endpoint
      description: '**Start here.** Returns your account info plus all available slugs and example calls.


        No more guessing what to pass — this endpoint tells you everything you need to make your first request.'
      operationId: discovery_endpoint_v1_discovery_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: {}
              example:
                data:
                  account:
                    tier: free
                    daily_limit: 100
                    key_prefix: ar_live_7a
                  quick_start:
                    step_1: GET /v1/discovery  ← you are here
                    step_2: Pick a trade slug below, e.g. electrician
                    step_3: GET /v1/trades/electrician/prices?state=NSW&country=AU
                    step_4: Pick a service slug below, e.g. netflix
                    step_5: GET /v1/prices/netflix?country=AU
                  trades:
                  - slug: electrician
                    name: Electrician
                    service_count: 4
                  - slug: plumber
                    name: Plumber
                    service_count: 4
                  categories:
                  - slug: streaming-video
                    name: Streaming Video
                    service_count: 15
                  - slug: music-streaming
                    name: Music Streaming
                    service_count: 6
                  popular_service_slugs:
                  - netflix
                  - spotify
                  - adobe-creative-cloud
                  - microsoft-365
                  country_codes:
                  - AU
                  - US
                  - UK
                  - CA
                  - NZ
                  docs: https://api.aristocles.com.au/docs
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError