Skip to content

Commit 92760c9

Browse files
committed
Document /txs/package endpoint
1 parent 6dc29f0 commit 92760c9

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

API.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,23 @@ Broadcast a raw transaction to the network.
6666
The transaction should be provided as hex in the request body.
6767
The `txid` will be returned on success.
6868

69+
### `POST /txs/package`
70+
71+
Broadcast a package of raw transactions to the network.
72+
73+
A transaction package is a group of related transactions that may depend on each other (e.g., a child transaction spending outputs from an unconfirmed parent transaction). This is useful for CPFP (Child Pays For Parent) and other scenarios where transactions need to be evaluated together.
74+
75+
The request body should contain a JSON array of transaction hex strings.
76+
77+
Example request body:
78+
```json
79+
["02000000...", "02000000..."]
80+
```
81+
82+
Returns a JSON object containing the package acceptance result. On success, returns information about each transaction in the package.
83+
84+
*Note:* This endpoint requires Bitcoin Core 28.0 or later.
85+
6986
## Addresses
7087

7188
### `GET /address/:address`

0 commit comments

Comments
 (0)