Aristocles Pty Ltd Stock Market Indices API

openapi: 3.2.0
info:
  title: Aristocles Data Stock Market Indices 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: Stock Market Indices
  description: 'A reference list of every company currently in the S&P 500 index, with ticker symbol, company name, industry sector and sub-industry, headquarters location, date added to the index, SEC CIK number and founding year. Fintech startups, trading bots, portfolio tools and AI research agents use it to screen large-cap US equities and map tickers to sectors. Source: S&P 500 constituents data from the datasets/s-and-p-500-companies project (github.com/datasets). Licence: ODC-PDDL-1.0. Base path: /v1/data/s-p-500-company-constituents. Requires an API key (X-API-Key).'
paths:
  /v1/data/s-p-500-company-constituents:
    get:
      tags:
      - Stock Market Indices
      summary: List S&P 500 Company Constituents records
      description: 'List S&P 500 Company Constituents records with optional filters and pagination.


        **Source:** S&P 500 constituents data from the datasets/s-and-p-500-companies project (github.com/datasets) (ODC-PDDL-1.0).


        **Fields returned:**

        - `symbol` (str) — Stock ticker symbol

        - `security` (str) — Company name

        - `gics_sector` (str) — Industry sector

        - `gics_sub_industry` (str) — Industry sub-category

        - `headquarters_location` (str) — City and state of company headquarters

        - `date_added` (str) — Date the company joined the index

        - `cik` (str) — SEC Central Index Key

        - `founded` (str) — Year the company was founded


        **Example:** `GET /v1/data/s-p-500-company-constituents?limit=10&gics_sector=example`'
      operationId: list_endpoint_v1_data_s_p_500_company_constituents_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: gics_sector
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Industry sector
          examples:
          - example
          title: Gics Sector
        description: Industry sector
      - name: gics_sub_industry
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Industry sub-category
          examples:
          - example
          title: Gics Sub Industry
        description: Industry sub-category
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: A page of S&P 500 Company Constituents records with pagination metadata.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - symbol: example
                    security: example
                    gics_sector: example
                    gics_sub_industry: example
                    headquarters_location: example
                    date_added: example
                    cik: example
                    founded: example
                  total: 1
                  limit: 25
                  offset: 0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/s-p-500-company-constituents/search:
    get:
      tags:
      - Stock Market Indices
      summary: Search S&P 500 Company Constituents by security
      description: 'Search S&P 500 Company Constituents records by `security` (partial, case-insensitive).


        **Example:** `GET /v1/data/s-p-500-company-constituents/search?q=exa`'
      operationId: search_endpoint_v1_data_s_p_500_company_constituents_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 100
          description: Case-insensitive partial match on security.
          examples:
          - exa
          title: Q
        description: Case-insensitive partial match on security.
      - 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 S&P 500 Company Constituents records.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - symbol: example
                    security: example
                    gics_sector: example
                    gics_sub_industry: example
                    headquarters_location: example
                    date_added: example
                    cik: example
                    founded: example
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/s-p-500-company-constituents/{key}:
    get:
      tags:
      - Stock Market Indices
      summary: Get one S&P 500 Company Constituents record by symbol
      description: 'Fetch a single S&P 500 Company Constituents record by its `symbol`.


        **Example:** `GET /v1/data/s-p-500-company-constituents/example`'
      operationId: get_endpoint_v1_data_s_p_500_company_constituents__key__get
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          description: The symbol value to look up (case-insensitive).
          examples:
          - example
          title: Key
        description: The symbol 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 S&P 500 Company Constituents record.
          content:
            application/json:
              schema: {}
              example:
                data:
                  symbol: example
                  security: example
                  gics_sector: example
                  gics_sub_industry: example
                  headquarters_location: example
                  date_added: example
                  cik: example
                  founded: example
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: No S&P 500 Company Constituents 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