> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirrortrade.co/llms.txt
> Use this file to discover all available pages before exploring further.

# What this key can do

> Returns the effective plan, tier, active tools, per-tool costs and limits (daily scope, minute units, concurrency and transport ceiling). Remaining usage is reported on data responses. The published MCP package calls this at startup to decide which tools to register, so it answers on the lowest tier.

Plans: Free, Pro.



## OpenAPI

````yaml https://alphayou.net/openapi.json get /api/mcp/whoami
openapi: 3.1.0
info:
  title: AlphaYou API
  version: 1.0.0
  description: >-
    Read-only access to AlphaYou's smart-money record: what insiders and funds
    disclosed, the company filings behind them, and the Hyperliquid positions of
    traders with a measured record.


    Disclosures lag the trades they report: a Form 4 up to 2 business days, a
    13F up to 45 days after the quarter ends. Hyperliquid positions carry the
    time they were observed.


    Plans:

    - Free: 4 tools, 100 requests a day, free.

    - Pro: 9 tools, 50,000 requests a day, $49 a month.


    Create a free key at https://alphayou.net/developers. Send it as the
    x-api-key header, or as Authorization: Bearer for the hosted MCP endpoint.


    Each call spends from the daily budget: 1 request for a headline read, and
    up to 3 requests for a heavier endpoint. Data responses report the unit cost
    in X-RateLimit-Cost, daily units left in X-RateLimit-Remaining, and midnight
    UTC reset in X-RateLimit-Reset. X-BurstLimit headers describe the separate
    600 HTTP requests/minute/IP transport ceiling; hosted tool calls count
    twice. Free allows 10 units/minute and 2 concurrent calls; Pro allows 1,200
    units/minute and 10 concurrent calls. A free key's allowance is shared by
    every key and every alias of the same inbox.


    Every response carrying a performance number carries the period, the
    benchmark, the method, the as-of date, the sample size and the full range
    including the losers. Numbers without those six are not published.


    Use of the API is governed by the API terms at
    https://alphayou.net/legal/api-terms.
  termsOfService: https://alphayou.net/legal/api-terms
  contact:
    name: AlphaYou
    url: https://alphayou.net/developers
    email: info@alphayou.net
servers:
  - url: https://api.alphayou.net
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /api/mcp/whoami:
    get:
      tags:
        - AlphaYou
      summary: What this key can do
      description: >-
        Returns the effective plan, tier, active tools, per-tool costs and
        limits (daily scope, minute units, concurrency and transport ceiling).
        Remaining usage is reported on data responses. The published MCP package
        calls this at startup to decide which tools to register, so it answers
        on the lowest tier.


        Plans: Free, Pro.
      operationId: whoami
      responses:
        '200':
          description: The requested records.
        '401':
          description: Missing, unrecognised or revoked API key (error key_revoked).
        '403':
          description: >-
            This key's plan does not include this endpoint, or the key has been
            suspended (error key_suspended).
        '404':
          description: Not an endpoint an API key may call.
        '429':
          description: >-
            Rate limited. The scope field says which budget ran out: minute,
            day, account (shared by all of an account's keys), or concurrency
            (too many calls running at once). Retry-After says when to come
            back, and X-RateLimit-Remaining reports what is left of today's
            budget. A call refused for going too fast (the per-minute limit)
            does not use up the day, so wait for Retry-After and try again.
        '503':
          description: >-
            The request budget could not be checked right now. Retry after the
            number of seconds in Retry-After.
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    BearerAuth:
      type: http
      scheme: bearer
      description: Your AlphaYou API key (ay_...).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.