Join our community of builders on

Telegram!Telegram

Relayer API Reference

Development Documentation

You're viewing documentation for unreleased features from the main branch. For production use, see the latest stable version (v1.1.x).

Relayers

List Relayers

Lists all relayers with pagination support

Create Relayer

Creates a new relayer

Get Relayer

Retrieves details of a specific relayer by ID

Delete Relayer

Deletes a relayer by ID

Update Relayer

Updates a relayer's information

Get Relayer Balance

Retrieves the balance of a specific relayer

RPC

Performs a JSON-RPC call using the specified relayer

Sign

Signs data using the specified relayer

Sign Transaction

Signs a transaction using the specified relayer (Stellar only)

Sign Typed Data

Signs typed data using the specified relayer

Get Relayer Status

Fetches the current status of a specific relayer

Send Transaction

Sends a transaction through the specified relayer

List Transactions

Lists all transactions for a specific relayer with pagination

Get Transaction by Nonce

Retrieves a transaction by its nonce value

Delete Pending Transactions

Deletes all pending transactions for a specific relayer

Get Transaction by ID

Retrieves a specific transaction by its ID

Replace Transaction

Replaces a specific transaction with a new one

Cancel Transaction

Cancels a specific transaction by its ID

Plugins

Call Plugin

Calls a plugin method

Notifications

List Notifications

Lists all notifications with pagination support

Create Notification

Creates a new notification

Get Notification

Retrieves details of a specific notification by ID

Delete Notification

Deletes a notification by ID

Update Notification

Updates an existing notification

Signers

List Signers

Lists all signers with pagination support

Create Signer

Creates a new signer

Get Signer

Retrieves details of a specific signer by ID

Delete Signer

Deletes a signer by ID

Update Signer

Updates an existing signer

Metrics

Scrape Metrics

Triggers an update of system metrics and returns the result in plain text format

List Metrics

Returns a list of all available metric names in JSON format

Metric Detail

Returns the details of a specific metric in plain text format

Health

Health

Health routes implementation