Aristocles Pty Ltd RBA Economic Data API

openapi: 3.2.0
info:
  title: Aristocles Data RBA Economic Data 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: RBA Economic Data
  description: 'Reserve Bank of Australia statistical data — cash rate, AUD exchange rates, CPI inflation, mortgage rates, and credit aggregates. Source: RBA (CC BY 4.0). Updated monthly.'
paths:
  /v1/rba:
    get:
      tags:
      - RBA Economic Data
      summary: RBA data coverage
      description: 'Coverage summary: categories, series counts, and latest data dates.'
      operationId: rba_metadata_v1_rba_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: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/series:
    get:
      tags:
      - RBA Economic Data
      summary: List all available series
      description: List all RBA data series with their latest value and date.
      operationId: list_series_endpoint_v1_rba_series_get
      parameters:
      - name: category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter by category: interest_rates, exchange_rates, inflation, credit, mortgage_rates'
          title: Category
        description: 'Filter by category: interest_rates, exchange_rates, inflation, credit, mortgage_rates'
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/cash-rate:
    get:
      tags:
      - RBA Economic Data
      summary: RBA cash rate
      description: 'RBA Cash Rate Target and effective overnight interbank rate.


        Returns the current rate and historical series. The cash rate is the key

        monetary policy lever — it directly influences mortgage rates and the AUD.'
      operationId: cash_rate_endpoint_v1_rba_cash_rate_get
      parameters:
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Number of observations to return
          default: 24
          title: Periods
        description: Number of observations to return
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/exchange-rates:
    get:
      tags:
      - RBA Economic Data
      summary: AUD exchange rates
      description: 'Latest AUD exchange rates against all tracked currencies.


        Returns the most recent rate for each currency pair. Daily data going back to 1983.

        For full history of a specific pair, use GET /v1/rba/exchange-rates/{currency}.'
      operationId: exchange_rates_endpoint_v1_rba_exchange_rates_get
      parameters:
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: Number of observations
          default: 30
          title: Periods
        description: Number of observations
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/exchange-rates/{currency}:
    get:
      tags:
      - RBA Economic Data
      summary: AUD/XXX rate history
      description: 'Full daily history for a specific AUD currency pair.


        Example: GET /v1/rba/exchange-rates/USD → AUD/USD history

        Supported: USD, EUR, GBP, JPY, CNY, CAD, NZD, SGD, HKD, KRW, and more.'
      operationId: exchange_rate_history_endpoint_v1_rba_exchange_rates__currency__get
      parameters:
      - name: currency
        in: path
        required: true
        schema:
          type: string
          title: Currency
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Number of daily observations
          default: 90
          title: Periods
        description: Number of daily observations
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/inflation:
    get:
      tags:
      - RBA Economic Data
      summary: Consumer Price Index (CPI)
      description: 'Australian CPI inflation series — headline, trimmed mean, and weighted median.


        Quarterly data back to 1948. Use for real-wage calculators, cost-of-living

        adjustments, and economic dashboards.'
      operationId: inflation_endpoint_v1_rba_inflation_get
      parameters:
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Number of quarterly observations
          default: 20
          title: Periods
        description: Number of quarterly observations
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/mortgage-rates:
    get:
      tags:
      - RBA Economic Data
      summary: Housing lending rates
      description: 'RBA housing lending rate indicators — standard variable rate, fixed rates (1–3 year),

        and new loan rates.


        Monthly data. Use for mortgage calculators and rate comparison tools.'
      operationId: mortgage_rates_endpoint_v1_rba_mortgage_rates_get
      parameters:
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Number of monthly observations
          default: 24
          title: Periods
        description: Number of monthly observations
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/credit:
    get:
      tags:
      - RBA Economic Data
      summary: Credit and lending aggregates
      description: 'Total credit outstanding by sector — housing, business, personal, and total.


        Monthly growth rates and levels. Use for macro dashboards and economic analysis.'
      operationId: credit_endpoint_v1_rba_credit_get
      parameters:
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Number of monthly observations
          default: 24
          title: Periods
        description: Number of monthly observations
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/rba/series/{series_code}:
    get:
      tags:
      - RBA Economic Data
      summary: Get any series by code
      description: 'Retrieve any RBA data series by its series code.


        Use GET /v1/rba/series to discover available codes.


        Example series codes:

        - `ARBAMPCNCRT` — Cash Rate Target

        - `FXRUSD` — AUD/USD daily rate

        - `GCPIAG` — Headline CPI

        - `FILRHLBVS` — Standard variable mortgage rate'
      operationId: get_series_endpoint_v1_rba_series__series_code__get
      parameters:
      - name: series_code
        in: path
        required: true
        schema:
          type: string
          title: Series Code
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 2000
          minimum: 1
          description: Number of observations (ignored if start_date set)
          default: 40
          title: Periods
        description: Number of observations (ignored if start_date set)
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Return all observations from this date (YYYY-MM-DD)
          title: Start Date
        description: Return all observations from this date (YYYY-MM-DD)
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '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