Aristocles Pty Ltd Gross Domestic Product API

openapi: 3.2.0
info:
  title: Aristocles Data Gross Domestic Product 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: Gross Domestic Product
  description: 'Gross domestic product at current US dollar prices for every country and regional aggregate, one row per country per year. The data comes from the World Bank''s World Development Indicators, the standard reference series for cross-country economic comparison. Analysts, market-sizing tools and AI research agents use it to rank markets, normalise metrics per unit of economy and build country scoring models. Source: Source: World Bank, World Development Indicators (CC BY 4.0). Licence: CC BY 4.0. Base path: /v1/data/global-gross-domestic-product. Requires an API key (X-API-Key).'
paths:
  /v1/data/global-gross-domestic-product:
    get:
      tags:
      - Gross Domestic Product
      summary: List Global Gross Domestic Product records
      description: 'List Global Gross Domestic Product records with optional filters and pagination.


        **Source:** Source: World Bank, World Development Indicators (CC BY 4.0) (CC BY 4.0).


        **Fields returned:**

        - `country_name` (str) — Country or aggregate region name

        - `country_code` (str) — Three-letter country code

        - `indicator_name` (str) — Name of the indicator series being reported

        - `year` (int) — Calendar year of the observation

        - `gdp_usd` (float) — Gross domestic product in current US dollars; null where not reported


        **Example:** `GET /v1/data/global-gross-domestic-product?limit=10&country_code=example`'
      operationId: list_endpoint_v1_data_global_gross_domestic_product_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_code
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Three-letter country code
          examples:
          - example
          title: Country Code
        description: Three-letter country code
      - name: country_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Country or aggregate region name
          examples:
          - example
          title: Country Name
        description: Country or aggregate region name
      - name: year
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Calendar year of the observation
          examples:
          - '42'
          title: Year
        description: Calendar year of the observation
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: A page of Global Gross Domestic Product records with pagination metadata.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - country_name: example
                    country_code: example
                    indicator_name: example
                    year: 42
                    gdp_usd: 4.2
                  total: 1
                  limit: 25
                  offset: 0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/global-gross-domestic-product/search:
    get:
      tags:
      - Gross Domestic Product
      summary: Search Global Gross Domestic Product by country_name
      description: 'Search Global Gross Domestic Product records by `country_name` (partial, case-insensitive).


        **Example:** `GET /v1/data/global-gross-domestic-product/search?q=exa`'
      operationId: search_endpoint_v1_data_global_gross_domestic_product_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 100
          description: Case-insensitive partial match on country_name.
          examples:
          - exa
          title: Q
        description: Case-insensitive partial match on country_name.
      - 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 Gross Domestic Product records.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - country_name: example
                    country_code: example
                    indicator_name: example
                    year: 42
                    gdp_usd: 4.2
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/global-gross-domestic-product/{key}:
    get:
      tags:
      - Gross Domestic Product
      summary: Get one Global Gross Domestic Product record by country_code
      description: 'Fetch a single Global Gross Domestic Product record by its `country_code`.


        **Example:** `GET /v1/data/global-gross-domestic-product/example`'
      operationId: get_endpoint_v1_data_global_gross_domestic_product__key__get
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          description: The country_code value to look up (case-insensitive).
          examples:
          - example
          title: Key
        description: The country_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 Global Gross Domestic Product record.
          content:
            application/json:
              schema: {}
              example:
                data:
                  country_name: example
                  country_code: example
                  indicator_name: example
                  year: 42
                  gdp_usd: 4.2
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: No Global Gross Domestic Product 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