Manage BTCMatic dry-run Bitcoin rules, read their fires and orders, run backtests and watch addresses.
Explore 35 workflow actions for BTCMatic, including account permissions and operation limits.
22 read actions13 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Acknowledge a fire
Write
Acknowledge an escalating fire, which stops its escalation chain.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a dry-run rule
Write
Create a rule (trigger, condition, action) that runs in dry-run mode: order actions are simulated, never placed. Live order rules can only be turned on in the BTCMatic app.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a community rule
Write
Delete one of your community rule submissions.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a rule
Write
Delete a rule permanently.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a share card
Write
Delete one of your share cards; its public address stops working.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete an address policy
Write
Deletes the policy (idempotent within an existing address; never plan-gated - removing protection is always allowed).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a backtest
Read
Answers with queued/running/complete (with the report) or failed (with a stable error code) for a backtest id returned by POST /backtests.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get a community rule
Read
Public: the full card by submission id (sub_...) or short code - rule, sentence, both proof periods with metrics and a FIRE/SKIP trace sample, honesty, baseline, signals, and.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get a guard report
Read
Get a Treasury Guard report: outgoing activity of a watched address with policy verdicts and alarms (Power plan).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get a rule
Read
Answers with a rule you own; 404 otherwise.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get a share card
Read
Get a published comparison share card.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get an address policy
Read
Answers with the stored policy; 404 when the address has none.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get an engine report
Read
Get the engine report for a period key (2026-07 monthly, 2026-W28 weekly, 2026-07-15 daily).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get my stack
Read
Get the products in your self-custody stack (they filter radar views).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get the account
Read
The identity behind the bearer token: user id, contact email (null for npub-only accounts), npub, public handle (null until claimed) and every linked identity.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Get the ticker
Read
Get the latest price, fee estimate, 24-hour fire count and event-to-action latency.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List capabilities
Read
Namespaces adapters have claimed, with the trigger types and metrics they serve.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List community rules
Read
List community rule submissions, newest first, with the jury-selected ones.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List engine reports
Read
Generated engine reports, newest first.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List gallery templates
Read
List the curated rule templates with their backtest badges.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List inbound hooks
Read
List active inbound hooks (their tokens and signing secrets are never returned).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List orders
Read
Orders placed by your rules (live and simulated) with their status (claimed, submitted, filled, partial, rejected or expired), newest first.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List radar incidents
Read
List open and past security incidents for self-custody products, newest first.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List radar sources
Read
Per-source precision from manually labeled feed items - the curation ledger made live.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List rule fires
Read
Fires of your rules, newest first, each carrying the evaluation trace (why the rule matched).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List rules
Read
List your rules with their lifecycle status.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List share cards
Read
List published comparison share cards (metadata only).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
List watched addresses
Read
Bitcoin addresses whose activity feeds your address_activity rules.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
Pause a rule
Write
Pause a rule from any state (resuming is done in the BTCMatic app).
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Revoke an inbound hook
Write
Revoke an inbound hook; deliveries to it fail from the next request on.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run a backtest
Write
Replay one of your rules (or an inline rule document) over historical candles and fees; a cached result answers at once, otherwise poll Get a backtest.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set an address policy
Write
Set the Treasury Guard policy of a watched address: allowed outgoing windows and an optional destination allow-list.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set my stack
Write
Replace the products in your self-custody stack.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stop watching an address
Write
Removes the subscription; the chain adapter unsubscribes via LISTEN/NOTIFY.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Watch an address
Write
Watch a Bitcoin address so address activity rules can fire on it.
Permissions and limits
Account permissions
A BTCMatic API key (Pro or Power plan)
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in BTCMatic. A saved workflow is not a completed provider action.