Aristocles Pty Ltd Currency Exchange Rates API

openapi: 3.2.0
info:
  title: Aristocles Data Currency Exchange Rates 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: Currency Exchange Rates
  description: 'A dated table of official foreign currency exchange rates published by the US Treasury, covering every currency the US government transacts in. Each row gives a country, its currency, the effective date and the rate used to convert that currency into US dollars. Finance, accounting, invoicing and cross-border commerce teams use it as an auditable, government-sourced alternative to commercial FX feeds. Source: Source: U.S. Department of the Treasury, Fiscal Data (fiscaldata.treasury.gov). Licence: Public domain (US Government work, free to use per Fiscal Data licence). Base path: /v1/data/global-currency-exchange-rates. Requires an API key (X-API-Key).'
paths:
  /v1/data/global-currency-exchange-rates:
    get:
      tags:
      - Currency Exchange Rates
      summary: List Global Currency Exchange Rates records
      description: 'List Global Currency Exchange Rates records with optional filters and pagination.


        **Source:** Source: U.S. Department of the Treasury, Fiscal Data (fiscaldata.treasury.gov) (Public domain (US Government work, free to use per Fiscal Data licence)).


        **Fields returned:**

        - `record_date` (date) — Date the rate was published in the Treasury report

        - `country` (str) — Country or issuing authority of the currency

        - `currency` (str) — Currency name, for example Dollar or Euro

        - `country_currency_desc` (str) — Combined country and currency label, for example Australia-Dollar

        - `exchange_rate` (float) — Units of the foreign currency per one US dollar

        - `effective_date` (date) — Date from which the rate applies

        - `record_calendar_year` (int) — Calendar year of the published rate

        - `record_calendar_month` (int) — Calendar month of the published rate


        **Example:** `GET /v1/data/global-currency-exchange-rates?limit=10&country=example`'
      operationId: list_endpoint_v1_data_global_currency_exchange_rates_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Max records to return (1-100).
          default: 25
          title: Limit
        description: Max records to return (1-100).
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Records to skip, for pagination.
          default: 0
          title: Offset
        description: Records to skip, for pagination.
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Country or issuing authority of the currency
          examples:
          - example
          title: Country
        description: Country or issuing authority of the currency
      - name: currency
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Currency name, for example Dollar or Euro
          examples:
          - example
          title: Currency
        description: Currency name, for example Dollar or Euro
      - name: record_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Date the rate was published in the Treasury report
          examples:
          - '2026-01-01'
          title: Record Date
        description: Date the rate was published in the Treasury report
      - name: effective_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Date from which the rate applies
          examples:
          - '2026-01-01'
          title: Effective Date
        description: Date from which the rate applies
      - name: record_calendar_year
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Calendar year of the published rate
          examples:
          - '42'
          title: Record Calendar Year
        description: Calendar year of the published rate
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: A page of Global Currency Exchange Rates records with pagination metadata.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - record_date: '2026-01-01'
                    country: example
                    currency: example
                    country_currency_desc: example
                    exchange_rate: 4.2
                    effective_date: '2026-01-01'
                    record_calendar_year: 42
                    record_calendar_month: 42
                  total: 1
                  limit: 25
                  offset: 0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/global-currency-exchange-rates/search:
    get:
      tags:
      - Currency Exchange Rates
      summary: Search Global Currency Exchange Rates by country_currency_desc
      description: 'Search Global Currency Exchange Rates records by `country_currency_desc` (partial, case-insensitive).


        **Example:** `GET /v1/data/global-currency-exchange-rates/search?q=exa`'
      operationId: search_endpoint_v1_data_global_currency_exchange_rates_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 100
          description: Case-insensitive partial match on country_currency_desc.
          examples:
          - exa
          title: Q
        description: Case-insensitive partial match on country_currency_desc.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Max records to return (1-100).
          default: 25
          title: Limit
        description: Max records to return (1-100).
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Matching Global Currency Exchange Rates records.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - record_date: '2026-01-01'
                    country: example
                    currency: example
                    country_currency_desc: example
                    exchange_rate: 4.2
                    effective_date: '2026-01-01'
                    record_calendar_year: 42
                    record_calendar_month: 42
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/global-currency-exchange-rates/{key}:
    get:
      tags:
      - Currency Exchange Rates
      summary: Get one Global Currency Exchange Rates record by country_currency_desc
      description: 'Fetch a single Global Currency Exchange Rates record by its `country_currency_desc`.


        **Example:** `GET /v1/data/global-currency-exchange-rates/example`'
      operationId: get_endpoint_v1_data_global_currency_exchange_rates__key__get
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          description: The country_currency_desc value to look up (case-insensitive).
          examples:
          - example
          title: Key
        description: The country_currency_desc value to look up (case-insensitive).
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: A single Global Currency Exchange Rates record.
          content:
            application/json:
              schema: {}
              example:
                data:
                  record_date: '2026-01-01'
                  country: example
                  currency: example
                  country_currency_desc: example
                  exchange_rate: 4.2
                  effective_date: '2026-01-01'
                  record_calendar_year: 42
                  record_calendar_month: 42
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: No Global Currency Exchange Rates record for '...'.
          description: Not Found
        '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