Aristocles Pty Ltd Emoji API

openapi: 3.2.0
info:
  title: Aristocles Data Emoji 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: Emoji
  description: 'A reference catalogue of standard emoji characters, each with a plain-English description, category grouping, and the Unicode and iOS versions that introduced it. Used by chat apps, social tools, keyboards, and AI agents that need to interpret, search, or suggest emoji. Source: Emoji data from GitHub gemoji (MIT License). Licence: MIT. Base path: /v1/data/emoji-directory. Requires an API key (X-API-Key).'
paths:
  /v1/data/emoji-directory:
    get:
      tags:
      - Emoji
      summary: List Emoji Directory records
      description: 'List Emoji Directory records with optional filters and pagination.


        **Source:** Emoji data from GitHub gemoji (MIT License) (MIT).


        **Fields returned:**

        - `emoji` (str) — The emoji character itself

        - `description` (str) — Plain-English name of the emoji

        - `category` (str) — Emoji category such as Smileys & Emotion or Food & Drink

        - `unicode_version` (str) — Unicode version that introduced the emoji

        - `ios_version` (str) — iOS version that first supported the emoji


        **Example:** `GET /v1/data/emoji-directory?limit=10&category=example`'
      operationId: list_endpoint_v1_data_emoji_directory_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: category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Emoji category such as Smileys & Emotion or Food & Drink
          examples:
          - example
          title: Category
        description: Emoji category such as Smileys & Emotion or Food & Drink
      - name: unicode_version
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Unicode version that introduced the emoji
          examples:
          - example
          title: Unicode Version
        description: Unicode version that introduced the emoji
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: A page of Emoji Directory records with pagination metadata.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - emoji: example
                    description: example
                    category: example
                    unicode_version: example
                    ios_version: example
                  total: 1
                  limit: 25
                  offset: 0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/emoji-directory/search:
    get:
      tags:
      - Emoji
      summary: Search Emoji Directory by description
      description: 'Search Emoji Directory records by `description` (partial, case-insensitive).


        **Example:** `GET /v1/data/emoji-directory/search?q=exa`'
      operationId: search_endpoint_v1_data_emoji_directory_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 100
          description: Case-insensitive partial match on description.
          examples:
          - exa
          title: Q
        description: Case-insensitive partial match on description.
      - 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 Emoji Directory records.
          content:
            application/json:
              schema: {}
              example:
                data:
                  items:
                  - emoji: example
                    description: example
                    category: example
                    unicode_version: example
                    ios_version: example
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/data/emoji-directory/{key}:
    get:
      tags:
      - Emoji
      summary: Get one Emoji Directory record by emoji
      description: 'Fetch a single Emoji Directory record by its `emoji`.


        **Example:** `GET /v1/data/emoji-directory/example`'
      operationId: get_endpoint_v1_data_emoji_directory__key__get
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          description: The emoji value to look up (case-insensitive).
          examples:
          - example
          title: Key
        description: The emoji 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 Emoji Directory record.
          content:
            application/json:
              schema: {}
              example:
                data:
                  emoji: example
                  description: example
                  category: example
                  unicode_version: example
                  ios_version: example
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: No Emoji Directory 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