Aristocles Pty Ltd Currency Codes API

openapi: 3.2.0
info:
  title: Aristocles Data Currency Codes 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 Codes
  description: 'The international reference list of currency codes, showing which countries and territories use each currency, its alphabetic and numeric code, the number of minor units (decimal places), and any withdrawal date for retired currencies. Payment, fintech, e-commerce and accounting teams need it to validate, format and convert monetary amounts correctly. Source: Currency code data from the Frictionless Data core datasets (github.com/datasets/currency-codes), derived from the ISO 4217 maintenance agency list.. Licence: ODC PDDL 1.0. Base path: /v1/data/world-currency-codes. Requires an API key (X-API-Key).'
paths:
  /v1/data/world-currency-codes:
    get:
      tags:
      - Currency Codes
      summary: List World Currency Codes records
      description: 'List World Currency Codes records with optional filters and pagination.


        **Source:** Currency code data from the Frictionless Data core datasets (github.com/datasets/currency-codes), derived from the ISO 4217 maintenance agency list. (ODC PDDL 1.0).


        **Fields returned:**

        - `entity` (str) — Country or territory that uses the currency

        - `currency` (str) — Currency name

        - `alphabetic_code` (str) — Three-letter currency code, e.g. AUD

        - `numeric_code` (str) — Three-digit numeric currency code

        - `minor_unit` (str) — Number of decimal places used for the currency

        - `withdrawal_date` (str) — Date the currency was withdrawn, if retired


        **Example:** `GET /v1/data/world-currency-codes?limit=10&entity=example`'
      operationId: list_endpoint_v1_data_world_currency_codes_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: entity
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Country or territory that uses the currency
          examples:
          - example
          title: Entity
        description: Country or territory that uses the currency
      - name: alphabetic_code
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Three-letter currency code, e.g. AUD
          examples:
          - example
          title: Alphabetic Code
        description: Three-letter currency code, e.g. AUD
      - name: numeric_code
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Three-digit numeric currency code
          examples:
          - example
          title: Numeric Code
        description: Three-digit numeric currency code
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: A page of World Currency Codes records with pagination metadata.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - entity: example
                    currency: example
                    alphabetic_code: example
                    numeric_code: example
                    minor_unit: example
                    withdrawal_date: example
                  total: 1
                  limit: 25
                  offset: 0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/world-currency-codes/search:
    get:
      tags:
      - Currency Codes
      summary: Search World Currency Codes by currency
      description: 'Search World Currency Codes records by `currency` (partial, case-insensitive).


        **Example:** `GET /v1/data/world-currency-codes/search?q=exa`'
      operationId: search_endpoint_v1_data_world_currency_codes_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 100
          description: Case-insensitive partial match on currency.
          examples:
          - exa
          title: Q
        description: Case-insensitive partial match on currency.
      - 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 World Currency Codes records.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - entity: example
                    currency: example
                    alphabetic_code: example
                    numeric_code: example
                    minor_unit: example
                    withdrawal_date: example
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/world-currency-codes/{key}:
    get:
      tags:
      - Currency Codes
      summary: Get one World Currency Codes record by alphabetic_code
      description: 'Fetch a single World Currency Codes record by its `alphabetic_code`.


        **Example:** `GET /v1/data/world-currency-codes/example`'
      operationId: get_endpoint_v1_data_world_currency_codes__key__get
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          description: The alphabetic_code value to look up (case-insensitive).
          examples:
          - example
          title: Key
        description: The alphabetic_code 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 World Currency Codes record.
          content:
            application/json:
              schema: {}
              example:
                data:
                  entity: example
                  currency: example
                  alphabetic_code: example
                  numeric_code: example
                  minor_unit: example
                  withdrawal_date: example
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: No World Currency Codes 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