Stacks Blockchain API — Faucets

naftiko: 1.0.0-alpha2
info:
  label: Stacks Blockchain API — Faucets
  description: 'Stacks Blockchain API — Faucets. 3 operations. Lead operation: Add regtest BTC tokens to address. Self-contained
    Naftiko capability covering one Hiro business surface.'
  tags:
  - Hiro
  - Faucets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HIRO_API_KEY: HIRO_API_KEY
capability:
  consumes:
  - type: http
    namespace: stacks-blockchain-faucets
    baseUri: https://api.hiro.so
    description: Stacks Blockchain API — Faucets business capability. Self-contained, no shared references.
    resources:
    - name: extended-v1-faucets-btc
      path: /extended/v1/faucets/btc
      operations:
      - name: runfaucetbtc
        method: POST
        description: Add regtest BTC tokens to address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: address
          in: query
          type: string
          description: A valid regtest BTC address
        - name: large
          in: query
          type: boolean
          description: Request a large amount of regtest BTC than the default
        - name: xlarge
          in: query
          type: boolean
          description: Request an extra large amount of regtest BTC than the default
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: extended-v1-faucets-btc-address
      path: /extended/v1/faucets/btc/{address}
      operations:
      - name: getbtcbalance
        method: GET
        description: Get BTC balance for address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: address
          in: path
          type: string
          description: A valid regtest BTC address
          required: true
    - name: extended-v1-faucets-stx
      path: /extended/v1/faucets/stx
      operations:
      - name: runfaucetstx
        method: POST
        description: Get STX testnet tokens
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: address
          in: query
          type: string
          description: A valid testnet STX address
        - name: stacking
          in: query
          type: boolean
          description: Request the amount of STX tokens needed for individual address stacking
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: stacks-blockchain-faucets-rest
    port: 8080
    description: REST adapter for Stacks Blockchain API — Faucets. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/extended/v1/faucets/btc
      name: extended-v1-faucets-btc
      description: REST surface for extended-v1-faucets-btc.
      operations:
      - method: POST
        name: runfaucetbtc
        description: Add regtest BTC tokens to address
        call: stacks-blockchain-faucets.runfaucetbtc
        with:
          address: rest.address
          large: rest.large
          xlarge: rest.xlarge
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/extended/v1/faucets/btc/{address}
      name: extended-v1-faucets-btc-address
      description: REST surface for extended-v1-faucets-btc-address.
      operations:
      - method: GET
        name: getbtcbalance
        description: Get BTC balance for address
        call: stacks-blockchain-faucets.getbtcbalance
        with:
          address: rest.address
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/extended/v1/faucets/stx
      name: extended-v1-faucets-stx
      description: REST surface for extended-v1-faucets-stx.
      operations:
      - method: POST
        name: runfaucetstx
        description: Get STX testnet tokens
        call: stacks-blockchain-faucets.runfaucetstx
        with:
          address: rest.address
          stacking: rest.stacking
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stacks-blockchain-faucets-mcp
    port: 9090
    transport: http
    description: MCP adapter for Stacks Blockchain API — Faucets. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: add-regtest-btc-tokens-address
      description: Add regtest BTC tokens to address
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: stacks-blockchain-faucets.runfaucetbtc
      with:
        address: tools.address
        large: tools.large
        xlarge: tools.xlarge
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-btc-balance-address
      description: Get BTC balance for address
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stacks-blockchain-faucets.getbtcbalance
      with:
        address: tools.address
      outputParameters:
      - type: object
        mapping: $.
    - name: get-stx-testnet-tokens
      description: Get STX testnet tokens
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: stacks-blockchain-faucets.runfaucetstx
      with:
        address: tools.address
        stacking: tools.stacking
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.