Deposit

Get deposits handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/deposit

Query parameters

statusstring · enumRequired

The status of the in-flight sBTC deposit.

Possible values:

nextTokenstring · nullableOptional

the next token value from the previous return of this api call.

pageSizeinteger · int32 · nullableOptional

the maximum number of items in the response list.

Responses

200

Deposits retrieved successfully

application/json

Response to get deposits request.

nextTokenstring · nullableOptional

Next token for the search.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/deposit

HTTPcURLJavaScriptPython

GET /deposit?status=pending HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "deposits": [
    {
      "amount": 1,
      "bitcoinTxOutputIndex": 1,
      "bitcoinTxid": "text",
      "depositScript": "text",
      "lastUpdateBlockHash": "text",
      "lastUpdateHeight": 1,
      "recipient": "text",
      "reclaimScript": "text",
      "status": "pending"
    }
  ],
  "nextToken": "text"
}

Create deposit handler.

post

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/deposit

Body

application/json

Request structure for create deposit request.

bitcoinTxOutputIndexinteger · int32Required

Output index on the bitcoin transaction associated with this specific deposit.

bitcoinTxidstringRequired

Bitcoin transaction id.

depositScriptstringRequired

Deposit script.

reclaimScriptstringRequired

Reclaim script.

transactionHexstringRequired

The raw transaction hex.

Responses

200

Deposit already exists

application/json

Deposit.

amountinteger · int64Required

Amount of BTC being deposited in satoshis.

bitcoinTxOutputIndexinteger · int32Required

Output index on the bitcoin transaction associated with this specific deposit.

bitcoinTxidstringRequired

Bitcoin transaction id.

depositScriptstringRequired

Raw deposit script binary in hex.

lastUpdateBlockHashstringRequired

The most recent Stacks block hash the API was aware of when the deposit was last updated. If the most recent update is tied to an artifact on the Stacks blockchain then this hash is the Stacks block hash that contains that artifact.

lastUpdateHeightinteger · int64Required

The most recent Stacks block height the API was aware of when the deposit was last updated. If the most recent update is tied to an artifact on the Stacks blockchain then this height is the Stacks block height that contains that artifact.

recipientstringRequired

Stacks address to received the deposited sBTC.

reclaimScriptstringRequired

Raw reclaim script binary in hex.

replacedByTxstring · nullableOptional

Transaction ID of the transaction that replaced this one via RBF.

statusstring · enumRequired

The status of the in-flight sBTC deposit.

Possible values:

statusMessagestringRequired

The status message of the deposit.

201

Deposit created successfully

application/json

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

post

/deposit

HTTPcURLJavaScriptPython

POST /deposit HTTP/1.1
Host: localhost:3031
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "bitcoinTxOutputIndex": 1,
  "bitcoinTxid": "text",
  "depositScript": "text",
  "reclaimScript": "text",
  "transactionHex": "text"
}

{
  "amount": 1,
  "bitcoinTxOutputIndex": 1,
  "bitcoinTxid": "text",
  "depositScript": "text",
  "fulfillment": {
    "BitcoinBlockHash": "text",
    "BitcoinBlockHeight": 1,
    "BitcoinTxIndex": 1,
    "BitcoinTxid": "text",
    "BtcFee": 1,
    "StacksTxid": "text"
  },
  "lastUpdateBlockHash": "text",
  "lastUpdateHeight": 1,
  "parameters": {
    "lockTime": 1,
    "maxFee": 1
  },
  "recipient": "text",
  "reclaimScript": "text",
  "replacedByTx": "text",
  "status": "pending",
  "statusMessage": "text"
}

Update deposits handler.

put

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/deposit

Authorizations

ApiGatewayKey

x-api-keystringRequired

AWS Apigateway key

Body

application/json

Request structure for update deposit request.

Responses

200

Deposits updated successfully

application/json

Response to update deposits request.

400

Invalid request body

application/json

403

Forbidden

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

put

/deposit

HTTPcURLJavaScriptPython

PUT /deposit HTTP/1.1
Host: localhost:3031
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "deposits": [
    {
      "bitcoinTxOutputIndex": 1,
      "bitcoinTxid": "text",
      "fulfillment": {
        "BitcoinBlockHash": "text",
        "BitcoinBlockHeight": 1,
        "BitcoinTxIndex": 1,
        "BitcoinTxid": "text",
        "BtcFee": 1,
        "StacksTxid": "text"
      },
      "replacedByTx": "text",
      "status": "pending",
      "statusMessage": "text"
    }
  ]
}

{
  "deposits": [
    {
      "deposit": {
        "amount": 1,
        "bitcoinTxOutputIndex": 1,
        "bitcoinTxid": "text",
        "depositScript": "text",
        "fulfillment": {
          "BitcoinBlockHash": "text",
          "BitcoinBlockHeight": 1,
          "BitcoinTxIndex": 1,
          "BitcoinTxid": "text",
          "BtcFee": 1,
          "StacksTxid": "text"
        },
        "lastUpdateBlockHash": "text",
        "lastUpdateHeight": 1,
        "parameters": {
          "lockTime": 1,
          "maxFee": 1
        },
        "recipient": "text",
        "reclaimScript": "text",
        "replacedByTx": "text",
        "status": "pending",
        "statusMessage": "text"
      },
      "error": "text",
      "status": 1
    }
  ]
}

Get deposits by recipient handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/deposit/recipient/{recipient}

Path parameters

recipientstringRequired

the recipient to search by when getting all deposits.

Query parameters

nextTokenstring · nullableOptional

the next token value from the previous return of this api call.

pageSizeinteger · int32 · nullableOptional

the maximum number of items in the response list.

Responses

200

Deposits retrieved successfully

application/json

Response to get deposits request.

nextTokenstring · nullableOptional

Next token for the search.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/deposit/recipient/{recipient}

HTTPcURLJavaScriptPython

GET /deposit/recipient/{recipient} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "deposits": [
    {
      "amount": 1,
      "bitcoinTxOutputIndex": 1,
      "bitcoinTxid": "text",
      "depositScript": "text",
      "lastUpdateBlockHash": "text",
      "lastUpdateHeight": 1,
      "recipient": "text",
      "reclaimScript": "text",
      "status": "pending"
    }
  ],
  "nextToken": "text"
}

Get deposits by recipient handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/deposit/reclaim-pubkeys/{reclaimPubkeys}

Path parameters

reclaimPubkeysstringRequired

The dash-separated list of hex-encoded x-only pubkeys used to generate the reclaim_script.

Query parameters

nextTokenstring · nullableOptional

the next token value from the previous return of this api call.

pageSizeinteger · int32 · nullableOptional

the maximum number of items in the response list.

Responses

200

Deposits retrieved successfully

application/json

Response to get deposits request.

nextTokenstring · nullableOptional

Next token for the search.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/deposit/reclaim-pubkeys/{reclaimPubkeys}

HTTPcURLJavaScriptPython

GET /deposit/reclaim-pubkeys/{reclaimPubkeys} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "deposits": [
    {
      "amount": 1,
      "bitcoinTxOutputIndex": 1,
      "bitcoinTxid": "text",
      "depositScript": "text",
      "lastUpdateBlockHash": "text",
      "lastUpdateHeight": 1,
      "recipient": "text",
      "reclaimScript": "text",
      "status": "pending"
    }
  ],
  "nextToken": "text"
}

Get deposits for transaction handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/deposit/{txid}

Path parameters

txidstringRequired

txid associated with the Deposit.

Query parameters

nextTokenstring · nullableOptional

the next token value from the previous return of this api call.

pageSizeinteger · int32 · nullableOptional

the maximum number of items in the response list.

Responses

200

Deposits retrieved successfully

application/json

Response to get deposits for transaction request.

nextTokenstring · nullableOptional

Next token for the search.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/deposit/{txid}

HTTPcURLJavaScriptPython

GET /deposit/{txid} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "deposits": [
    {
      "amount": 1,
      "bitcoinTxOutputIndex": 1,
      "bitcoinTxid": "text",
      "depositScript": "text",
      "fulfillment": {
        "BitcoinBlockHash": "text",
        "BitcoinBlockHeight": 1,
        "BitcoinTxIndex": 1,
        "BitcoinTxid": "text",
        "BtcFee": 1,
        "StacksTxid": "text"
      },
      "lastUpdateBlockHash": "text",
      "lastUpdateHeight": 1,
      "parameters": {
        "lockTime": 1,
        "maxFee": 1
      },
      "recipient": "text",
      "reclaimScript": "text",
      "replacedByTx": "text",
      "status": "pending",
      "statusMessage": "text"
    }
  ],
  "nextToken": "text"
}

Get deposit handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/deposit/{txid}/{index}

Path parameters

txidstringRequired

txid associated with the Deposit.

indexstringRequired

output index associated with the Deposit.

Responses

200

Deposit retrieved successfully

application/json

Deposit.

amountinteger · int64Required

Amount of BTC being deposited in satoshis.

bitcoinTxOutputIndexinteger · int32Required

Output index on the bitcoin transaction associated with this specific deposit.

bitcoinTxidstringRequired

Bitcoin transaction id.

depositScriptstringRequired

Raw deposit script binary in hex.

lastUpdateBlockHashstringRequired

The most recent Stacks block hash the API was aware of when the deposit was last updated. If the most recent update is tied to an artifact on the Stacks blockchain then this hash is the Stacks block hash that contains that artifact.

lastUpdateHeightinteger · int64Required

The most recent Stacks block height the API was aware of when the deposit was last updated. If the most recent update is tied to an artifact on the Stacks blockchain then this height is the Stacks block height that contains that artifact.

recipientstringRequired

Stacks address to received the deposited sBTC.

reclaimScriptstringRequired

Raw reclaim script binary in hex.

replacedByTxstring · nullableOptional

Transaction ID of the transaction that replaced this one via RBF.

statusstring · enumRequired

The status of the in-flight sBTC deposit.

Possible values:

statusMessagestringRequired

The status message of the deposit.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/deposit/{txid}/{index}

HTTPcURLJavaScriptPython

GET /deposit/{txid}/{index} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "amount": 1,
  "bitcoinTxOutputIndex": 1,
  "bitcoinTxid": "text",
  "depositScript": "text",
  "fulfillment": {
    "BitcoinBlockHash": "text",
    "BitcoinBlockHeight": 1,
    "BitcoinTxIndex": 1,
    "BitcoinTxid": "text",
    "BtcFee": 1,
    "StacksTxid": "text"
  },
  "lastUpdateBlockHash": "text",
  "lastUpdateHeight": 1,
  "parameters": {
    "lockTime": 1,
    "maxFee": 1
  },
  "recipient": "text",
  "reclaimScript": "text",
  "replacedByTx": "text",
  "status": "pending",
  "statusMessage": "text"
}