> ## 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. # Supported protocol registry ## OpenAPI ````yaml /openapi.yaml get /v1/solana/protocols 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 `. 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: /v1/solana/protocols: get: tags: - catalogue summary: Supported protocol registry operationId: listProtocols parameters: - name: status in: query schema: $ref: '#/components/schemas/ProtocolStatus' responses: '200': description: Protocols content: application/json: schema: $ref: '#/components/schemas/ProtocolList' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/Unavailable' components: schemas: ProtocolStatus: type: string enum: - verified - awaiting_review - candidate - quarantined - disabled ProtocolList: type: object additionalProperties: false required: - universe - count - protocols properties: universe: type: string const: supported_adapters_only count: type: integer protocols: type: array items: $ref: '#/components/schemas/ProtocolEntry' ProtocolEntry: type: object required: - id - name - status - adapter_version properties: id: type: string name: type: string status: $ref: '#/components/schemas/ProtocolStatus' adapter_version: type: - string - 'null' program_ids: type: array items: $ref: '#/components/schemas/Address' categories: type: array items: $ref: '#/components/schemas/PositionCategory' capabilities: type: array items: type: string artifact_hash: type: - string - 'null' status_reason: type: - string - 'null' category: type: - string - 'null' logo_url: type: - string - 'null' format: uri metadata: oneOf: - $ref: '#/components/schemas/ProtocolMetadata' - type: 'null' ErrorEnvelope: type: object additionalProperties: false required: - error - request_id properties: error: type: object additionalProperties: false required: - code - message properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string details: type: object request_id: type: string Address: type: string pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$ PositionCategory: type: string enum: - lending - concentrated_lp - bin_lp - fungible_lp - vault - native_staking - liquid_staking - perpetual - rewards ProtocolMetadata: type: object additionalProperties: false required: - id - brand_id - display_name - logo_url - logo - website - trademark_owner - provenance properties: id: $ref: '#/components/schemas/AdapterId' brand_id: type: string display_name: type: string logo_url: type: - string - 'null' format: uri logo: oneOf: - $ref: '#/components/schemas/Logo' - type: 'null' website: type: - string - 'null' format: uri trademark_owner: type: - string - 'null' provenance: $ref: '#/components/schemas/MetadataProvenance' ErrorCode: type: string enum: - INVALID_PARAMETER - INVALID_ADDRESS - UNSUPPORTED_PROTOCOL - CURSOR_EXPIRED - UNAUTHORIZED - NOT_FOUND - JOB_NOT_FOUND - METHOD_NOT_ALLOWED - FORBIDDEN - CONFLICT - CONFIG_INVALID - RATE_LIMITED - INTERNAL - DB_UNAVAILABLE - QUEUE_UNAVAILABLE - SNAPSHOT_UNAVAILABLE - SCAN_FAILED - RPC_BUDGET_EXHAUSTED - ASSET_REMOVED AdapterId: type: string pattern: ^[a-z0-9_]{1,64}$ Logo: type: object additionalProperties: false required: - url - sizes - png_url - placeholder - placeholder_reason - initials - color properties: url: type: string format: uri description: 128 px WebP on our own host (/assets/v1/). Never a third-party URL. sizes: type: object additionalProperties: false properties: '32': type: string format: uri '64': type: string format: uri '128': type: string format: uri png_url: type: string format: uri placeholder: type: boolean placeholder_reason: type: - string - 'null' enum: - unverified - not_available - null initials: type: string maxLength: 2 description: 1–2 uppercase letters from the symbol (or '?') color: type: string pattern: ^#[0-9a-f]{6}$ description: >- Background colour for a text avatar, from an 8-colour palette chosen by sha256(subject id). MetadataProvenance: type: object additionalProperties: false required: - name_source - symbol_source - logo_source - logo_licence - onchain_slot - updated_at properties: name_source: type: - string - 'null' enum: - curated - token_2022 - metaplex - token_list_solana_labs - null symbol_source: type: - string - 'null' enum: - curated - token_2022 - metaplex - token_list_solana_labs - adapter - null logo_source: type: string enum: - token_2022_uri - metaplex_uri - brand_kit - protocol_github - favicon - curated_file - token_list_solana_labs - brand - placeholder logo_licence: type: string enum: - issuer_published - brand_guidelines - apache-2.0 - permission - own_work onchain_slot: type: - integer - 'null' updated_at: $ref: '#/components/schemas/Timestamp' Timestamp: type: string pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$ responses: BadRequest: description: >- INVALID_PARAMETER, INVALID_ADDRESS, UNSUPPORTED_PROTOCOL or CURSOR_EXPIRED content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' RateLimited: description: RATE_LIMITED headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unavailable: description: >- DB_UNAVAILABLE, QUEUE_UNAVAILABLE, SNAPSHOT_UNAVAILABLE, SCAN_FAILED, CONFIG_INVALID or RPC_BUDGET_EXHAUSTED headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' headers: RetryAfter: schema: type: integer minimum: 1 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.