{
  "opencollection": "1.0.0",
  "info": {
    "name": "Signer Metrics Accounts Faucets API",
    "version": "1.0.3"
  },
  "items": [
    {
      "info": {
        "name": "Faucets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add regtest BTC tokens to address",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hiro.so/extended/v1/faucets/btc",
            "params": [
              {
                "name": "address",
                "value": "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts",
                "type": "query",
                "description": "A valid regtest BTC address"
              },
              {
                "name": "large",
                "value": "",
                "type": "query",
                "description": "Request a large amount of regtest BTC than the default"
              },
              {
                "name": "xlarge",
                "value": "",
                "type": "query",
                "description": "Request an extra large amount of regtest BTC than the default"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add 0.01 BTC token to the specified regtest BTC address.\n\n        The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block\n        explorer. The tokens are delivered once the transaction has been included in a block.\n\n        **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet."
        },
        {
          "info": {
            "name": "Get BTC balance for address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hiro.so/extended/v1/faucets/btc/:address",
            "params": [
              {
                "name": "address",
                "value": "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts",
                "type": "path",
                "description": "A valid regtest BTC address"
              }
            ]
          },
          "docs": "Get BTC balance for address"
        },
        {
          "info": {
            "name": "Get STX testnet tokens",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hiro.so/extended/v1/faucets/stx",
            "params": [
              {
                "name": "address",
                "value": "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ",
                "type": "query",
                "description": "A valid testnet STX address"
              },
              {
                "name": "stacking",
                "value": "",
                "type": "query",
                "description": "Request the amount of STX tokens needed for individual address stacking"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with `ST`. If the `stacking`\n        parameter is set to `true`, the faucet will add the required number of tokens for individual stacking to the\n        specified testnet address.\n\n        The endpoint returns the transaction ID, which you can use to view the transaction in the\n        [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has\n        been included"
        }
      ]
    }
  ],
  "bundled": true
}