Skip to content

Update api doc including transaction package #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RCasatta merged 2 commits into from
Dec 1, 2025
Merged

Update api doc including transaction package #607

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6dc29f0
Add a note start_index must be multiple of 25
RCasatta Nov 21, 2025
92760c9
Document /txs/package endpoint
RCasatta Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,23 @@ Broadcast a raw transaction to the network.
The transaction should be provided as hex in the request body.
The `txid` will be returned on success.

### `POST /txs/package`

Broadcast a package of raw transactions to the network.

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.

The request body should contain a JSON array of transaction hex strings.

Example request body:
```json
["02000000...", "02000000..."]
```

Returns a JSON object containing the package acceptance result. On success, returns information about each transaction in the package.

*Note:* This endpoint requires Bitcoin Core 28.0 or later.

## Addresses

### `GET /address/:address`
Expand Down Expand Up @@ -144,6 +161,8 @@ Available fields: `in_best_chain` (boolean, false for orphaned blocks), `next_be

Returns a list of transactions in the block (up to 25 transactions beginning at `start_index`).

*Note:* The `start_index` value must be a multiple of 25.

The response from this endpoint can be cached indefinitely.

### `GET /block/:hash/txids`
Expand Down