Aristocles Pty Ltd Cybersecurity API

openapi: 3.2.0
info:
  title: Aristocles Data Cybersecurity 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: Cybersecurity
  description: 'A continuously updated catalogue of software and hardware vulnerabilities with confirmed real-world exploitation, each with its identifier, affected vendor and product, the required remediation action and a federal remediation deadline. It is the de-facto global prioritisation list for patching. Security vendors, managed service providers, compliance platforms and autonomous security agents all consume it. Source: Source: Cybersecurity and Infrastructure Security Agency (CISA), Known Exploited Vulnerabilities Catalog.. Licence: Public Domain (U.S. Government Work). Base path: /v1/data/known-exploited-software-vulnerabilities. Requires an API key (X-API-Key).'
paths:
  /v1/data/known-exploited-software-vulnerabilities:
    get:
      tags:
      - Cybersecurity
      summary: List Known Exploited Software Vulnerabilities records
      description: 'List Known Exploited Software Vulnerabilities records with optional filters and pagination.


        **Source:** Source: Cybersecurity and Infrastructure Security Agency (CISA), Known Exploited Vulnerabilities Catalog. (Public Domain (U.S. Government Work)).


        **Fields returned:**

        - `cve_id` (str) — Common Vulnerabilities and Exposures identifier for the flaw.

        - `vendor_project` (str) — Vendor or open-source project that publishes the affected software.

        - `product` (str) — Affected product name.

        - `vulnerability_name` (str) — Short human-readable name of the vulnerability.

        - `date_added` (date) — Date the vulnerability was added to the catalogue.

        - `short_description` (str) — Plain-language summary of the weakness and how it is abused.

        - `required_action` (str) — Remediation action required of US federal agencies.

        - `due_date` (date) — Deadline by which the required action must be completed.

        - `known_ransomware_campaign_use` (str) — Whether the flaw is known to be used in ransomware campaigns (''Known'' or ''Unknown'').

        - `notes` (str) — Reference links and additional vendor advisory notes.


        **Example:** `GET /v1/data/known-exploited-software-vulnerabilities?limit=10&vendor_project=example`'
      operationId: list_endpoint_v1_data_known_exploited_software_vulnerabilities_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: vendor_project
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Vendor or open-source project that publishes the affected software.
          examples:
          - example
          title: Vendor Project
        description: Vendor or open-source project that publishes the affected software.
      - name: product
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Affected product name.
          examples:
          - example
          title: Product
        description: Affected product name.
      - name: known_ransomware_campaign_use
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the flaw is known to be used in ransomware campaigns ('Known' or 'Unknown').
          examples:
          - example
          title: Known Ransomware Campaign Use
        description: Whether the flaw is known to be used in ransomware campaigns ('Known' or 'Unknown').
      - name: date_added
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Date the vulnerability was added to the catalogue.
          examples:
          - '2026-01-01'
          title: Date Added
        description: Date the vulnerability was added to the catalogue.
      - name: due_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Deadline by which the required action must be completed.
          examples:
          - '2026-01-01'
          title: Due Date
        description: Deadline by which the required action must be completed.
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: A page of Known Exploited Software Vulnerabilities records with pagination metadata.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - cve_id: example
                    vendor_project: example
                    product: example
                    vulnerability_name: example
                    date_added: '2026-01-01'
                    short_description: example
                    required_action: example
                    due_date: '2026-01-01'
                    known_ransomware_campaign_use: example
                    notes: example
                  total: 1
                  limit: 25
                  offset: 0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/known-exploited-software-vulnerabilities/search:
    get:
      tags:
      - Cybersecurity
      summary: Search Known Exploited Software Vulnerabilities by vulnerability_name
      description: 'Search Known Exploited Software Vulnerabilities records by `vulnerability_name` (partial, case-insensitive).


        **Example:** `GET /v1/data/known-exploited-software-vulnerabilities/search?q=exa`'
      operationId: search_endpoint_v1_data_known_exploited_software_vulnerabilities_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 100
          description: Case-insensitive partial match on vulnerability_name.
          examples:
          - exa
          title: Q
        description: Case-insensitive partial match on vulnerability_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 Known Exploited Software Vulnerabilities records.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - cve_id: example
                    vendor_project: example
                    product: example
                    vulnerability_name: example
                    date_added: '2026-01-01'
                    short_description: example
                    required_action: example
                    due_date: '2026-01-01'
                    known_ransomware_campaign_use: example
                    notes: example
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/known-exploited-software-vulnerabilities/{key}:
    get:
      tags:
      - Cybersecurity
      summary: Get one Known Exploited Software Vulnerabilities record by cve_id
      description: 'Fetch a single Known Exploited Software Vulnerabilities record by its `cve_id`.


        **Example:** `GET /v1/data/known-exploited-software-vulnerabilities/example`'
      operationId: get_endpoint_v1_data_known_exploited_software_vulnerabilities__key__get
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          description: The cve_id value to look up (case-insensitive).
          examples:
          - example
          title: Key
        description: The cve_id 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 Known Exploited Software Vulnerabilities record.
          content:
            application/json:
              schema: {}
              example:
                data:
                  cve_id: example
                  vendor_project: example
                  product: example
                  vulnerability_name: example
                  date_added: '2026-01-01'
                  short_description: example
                  required_action: example
                  due_date: '2026-01-01'
                  known_ransomware_campaign_use: example
                  notes: example
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: No Known Exploited Software Vulnerabilities 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