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

# Get sandbox Lightning execution profile

> Read the platform-scoped Sandbox Lightning Network Execution Profile singleton. If the platform has not saved an explicit profile yet, BLIPS returns the default singleton values. This sandbox resource is a quote-input surface only and affects newly created quotes after corridor confirmation, does not return quote outputs, and does not expose Lightning node, channel, liquidity, payment-hash, or routing details. POST /quotes remains the sole outward quote truth source.



## OpenAPI

````yaml /openapi/blips-public-reference.yaml get /sandbox/lightning-execution-profile
openapi: 3.1.0
info:
  title: BLIPS Public Reference API
  version: '2026-04-08'
  description: >-
    Public OpenAPI 3.1 subset for the first BLIPS Mintlify API Reference and
    Playground release. This document is bound to the confirmed Public Test
    Backend at https://public-test.blips.network, includes only the approved
    first-release public endpoints, uses only internal `$ref` values, and
    excludes callback-only webhook documentation and operator-only surfaces.
servers:
  - url: https://public-test.blips.network
    description: >-
      Confirmed Public Test Backend ingress target for public BLIPS API
      Reference, Playground, and internet-testable Try It flows.
security:
  - BasicAuth: []
tags:
  - name: Platform Setup
    description: >-
      Bootstrap and platform configuration surfaces for establishing the public
      BLIPS integration context.
  - name: Sandbox API
    description: >-
      Sandbox-only externally displayed helper surfaces. These routes either
      adjust quote inputs or create incoming-payment review cases, but they
      always feed the existing quote or transaction families and never become
      second outward API families.
  - name: Tokens
    description: >-
      Platform-scoped API credential create, list, detail, and revoke
      operations.
  - name: Customers
    description: >-
      Customer onboarding, profile lifecycle, and PPV payment-address issuance
      surfaces.
  - name: Accounts
    description: >-
      Customer-bound internal-account and external-account surfaces kept in the
      first-layer public contract.
  - name: Same-Currency Transfers
    description: >-
      Same-currency receiver lookup plus incoming and outgoing transfer
      primitives.
  - name: Cross-Currency Transfers
    description: >-
      PPV-first receiver lookup, quote creation/readback, and quote execution
      for cross-currency flows.
  - name: Transactions
    description: Transaction readback plus bounded incoming-review decision operations.
  - name: Webhooks
    description: >-
      Webhook connectivity verification surface for the public BLIPS
      integration.
paths:
  /sandbox/lightning-execution-profile:
    get:
      tags:
        - Sandbox API
      summary: Get sandbox Lightning execution profile
      description: >-
        Read the platform-scoped Sandbox Lightning Network Execution Profile
        singleton. If the platform has not saved an explicit profile yet, BLIPS
        returns the default singleton values. This sandbox resource is a
        quote-input surface only and affects newly created quotes after corridor
        confirmation, does not return quote outputs, and does not expose
        Lightning node, channel, liquidity, payment-hash, or routing details.
        POST /quotes remains the sole outward quote truth source.
      operationId: getSandboxLightningExecutionProfile
      parameters:
        - $ref: '#/components/parameters/XPlatformIdHeader'
      responses:
        '200':
          description: >-
            Current sandbox Lightning execution profile returned. When no
            explicit profile has been saved yet, this returns the
            platform-scoped default singleton values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxLightningExecutionProfile'
              examples:
                default:
                  value:
                    btcFiatSpreadBps: 10
                    lockPriceDurationSeconds: 300
        '400':
          description: Invalid platform context header.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SandboxLightningExecutionProfileBadRequestResponse
              examples:
                invalidPlatformId:
                  value:
                    error_code: INVALID_PLATFORM_ID
                    message: X-Platform-Id must be a UUIDv4 value
        '401':
          description: Missing or invalid authentication for the current platform context.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SandboxLightningExecutionProfileUnauthorizedResponse
              examples:
                unauthorized:
                  value:
                    error_code: UNAUTHORIZED
                    message: Unauthorized
        '404':
          description: >-
            The addressed platform context does not resolve to an existing
            platform.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SandboxLightningExecutionProfileNotFoundResponse
              examples:
                platformNotFound:
                  value:
                    error_code: PLATFORM_NOT_FOUND
                    message: Platform not found
      security:
        - BasicAuth: []
components:
  parameters:
    XPlatformIdHeader:
      name: X-Platform-Id
      in: header
      required: false
      description: >-
        Optional platform scope selector for sandbox multitenant/internal
        compatibility. Basic-auth integration requests normally omit this header
        because platform context is derived from credentials. If supplied, it
        must be a UUIDv4 value.
      schema:
        type: string
        pattern: >-
          ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
  schemas:
    SandboxLightningExecutionProfile:
      type: object
      description: >-
        Platform-scoped sandbox execution-profile input used during quote
        creation after corridor confirmation.
      additionalProperties: false
      required:
        - btcFiatSpreadBps
        - lockPriceDurationSeconds
      properties:
        btcFiatSpreadBps:
          type: integer
          minimum: 0
          maximum: 10000
          description: >-
            Platform-scoped BTC/fiat spread input in basis points. Sender and
            receiver platform values are summed at quote time to derive the
            effective corridor spread.
        lockPriceDurationSeconds:
          type: integer
          minimum: 30
          maximum: 3600
          description: >-
            Platform-scoped quote lock-duration input in seconds. Sender and
            receiver platform values are combined at quote time by taking the
            shorter duration.
    SandboxLightningExecutionProfileBadRequestResponse:
      type: object
      description: >-
        Sandbox Lightning execution-profile bad-request envelope returned for
        invalid platform-header or PATCH-body validation failures.
      additionalProperties: false
      required:
        - error_code
        - message
      properties:
        error_code:
          type: string
          enum:
            - INVALID_PLATFORM_ID
            - INVALID_REQUEST
          description: Stable sandbox error code for the rejected request.
        message:
          type: string
          description: Human-readable explanation of the sandbox request failure.
    SandboxLightningExecutionProfileUnauthorizedResponse:
      type: object
      description: Sandbox Lightning execution-profile unauthorized-response envelope.
      additionalProperties: false
      required:
        - error_code
        - message
      properties:
        error_code:
          type: string
          enum:
            - UNAUTHORIZED
          description: Stable sandbox error code for missing or invalid authentication.
        message:
          type: string
          description: Human-readable authorization failure summary.
    SandboxLightningExecutionProfileNotFoundResponse:
      type: object
      description: Sandbox Lightning execution-profile not-found-response envelope.
      additionalProperties: false
      required:
        - error_code
        - message
      properties:
        error_code:
          type: string
          enum:
            - PLATFORM_NOT_FOUND
          description: >-
            Stable sandbox error code when the addressed platform does not
            exist.
        message:
          type: string
          description: Human-readable not-found summary.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Integration-key Basic Auth (`clientId:clientSecret`) as documented in
        docs/public/AUTHENTICATION.md.

````