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

# Get endpoint parameters

> Retrieves all available parameters for an endpoint by providing a partial endpoint path. Useful for discovering what parameters an endpoint accepts. Path matching is case-insensitive.



## OpenAPI

````yaml /api-reference/openapi.json post /endpoints/parameters
openapi: 3.1.1
info:
  title: Alphractal API
  version: 0.3.0
  description: >-
    Alphractal API provides comprehensive cryptocurrency on-chain data including
    mining metrics, address analytics, block information, fee data, market
    indicators, supply metrics, exchange flows, and more.
servers:
  - url: https://api.alphractal.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /endpoints/parameters:
    post:
      tags:
        - Metadata
      summary: Get endpoint parameters
      description: >-
        Retrieves all available parameters for an endpoint by providing a
        partial endpoint path. Useful for discovering what parameters an
        endpoint accepts. Path matching is case-insensitive.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEndpointParameters'
      responses:
        '200':
          description: Endpoint parameters retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EndpointParameter'
        '400':
          description: Bad Request - Path parameter is required
        '404':
          description: Not Found - No endpoint found matching the provided path
        '500':
          description: Internal Server Error - OpenAPI spec not found or invalid
components:
  schemas:
    GetEndpointParameters:
      type: object
      properties:
        path:
          type: string
          description: >-
            Partial endpoint path (e.g., 'derivatives/Price' or
            '{asset}/derivatives/Price'). Matching is case-insensitive.
          example: derivatives/Price
      required:
        - path
      additionalProperties: false
    EndpointParameter:
      type: object
      properties:
        name:
          type: string
          description: Parameter name
        in:
          type: string
          description: Parameter location (path, query, header, body)
        required:
          type: boolean
          description: Whether the parameter is required
        type:
          type: string
          description: Parameter type (string, integer, number, boolean, etc.)
        format:
          type: string
          description: Parameter format (date-time, int32, double, etc.)
        description:
          type: string
          description: Parameter description
        example:
          type: string
          description: Example value
        enum:
          type: array
          description: Allowed values (for enum types)
          items:
            type: string
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key authentication. Include your API key in the X-Api-Key header for
        all requests.

````