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

# HTML API documentation page



## OpenAPI

````yaml /openapi.yaml get /
openapi: 3.1.0
info:
  title: Lucidblock Positions API
  version: 0.1.0
  summary: >-
    Read-only Solana DeFi positions with explicit coverage and sourced USD
    values.
  description: >
    For a Solana wallet, returns the lending, liquidity, staking, vault and
    perpetual positions found by

    verified protocol adapters, with exact per-leg amounts, sourced USD values
    and explicit coverage.


    Conventions: amounts (`amount_raw`) are non-negative base-10 integer
    strings; `amount` and every USD

    value are decimal strings; unknown values are `null`, never `"0"`. Times are
    ISO 8601 UTC with second

    precision. Addresses are base58 and case-sensitive. Absence of a position is
    trustworthy only for

    protocols whose coverage status is `complete`. Totals cover the supported
    universe only; they are not

    total wallet net worth.


    Every `/v1/*` response that passed the rate limiter carries
    `RateLimit-Limit`, `RateLimit-Remaining`

    and `RateLimit-Reset`; a 429 adds `Retry-After`. Every response carries
    `X-Request-Id`.


    While `PRIVATE_API_TOKEN` is configured (private alpha), every `/v1/*` route
    except `/v1/health`

    requires `Authorization: Bearer <token>`.


    Snapshots carry display metadata (names, symbols, first-party logo URLs
    under /assets/v1/, provenance)

    and a trademark notice: protocol and token names and logos belong to their
    owners and are shown for

    identification only (14-metadata.md). Metadata never changes ids, amounts or
    totals.
  license:
    name: Proprietary
servers:
  - url: https://api.lucidblock.xyz
    description: Production (private alpha until the v1 release gate)
security:
  - {}
  - AccessToken: []
tags:
  - name: meta
  - name: positions
  - name: catalogue
paths:
  /:
    get:
      tags:
        - meta
      summary: HTML API documentation page
      operationId: getDocsPage
      responses:
        '200':
          description: Docs page
          content:
            text/html:
              schema:
                type: string
      security:
        - {}
components:
  securitySchemes:
    AccessToken:
      type: http
      scheme: bearer
      description: >-
        PRIVATE_API_TOKEN, required on /v1/* (except /v1/health) while
        configured.

````

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