Relayer API Reference

Authentication

Call Plugin

Calls a plugin method.

Core Management

Relayers

• Create Relayer - Creates a new relayer
• List Relayers - Lists all relayers with pagination support
• Get Relayer - Retrieves details of a specific relayer by ID
• Update Relayer - Updates a relayer's information
• Delete Relayer - Deletes a relayer by ID
• Get Relayer Balance - Retrieves the balance of a specific relayer
• Get Relayer Status - Fetches the current status of a specific relayer

Signers

• Create Signer - Creates a new signer
• List Signers - Lists all signers with pagination support
• Get Signer - Retrieves details of a specific signer by ID
• Update Signer - Updates an existing signer
• Delete Signer - Deletes a signer by ID

Notifications

• Create Notification - Creates a new notification
• List Notifications - Lists all notifications with pagination support
• Get Notification - Retrieves details of a specific notification by ID
• Update Notification - Updates an existing notification
• Delete Notification - Deletes a notification by ID

Transaction Management

Transaction Operations

• Send Transaction - Sends a transaction through the specified relayer
• List Transactions - Lists all transactions for a specific relayer with pagination
• Get Transaction by ID - Retrieves a specific transaction by its ID
• Get Transaction by Nonce - Retrieves a transaction by its nonce value
• Replace Transaction - Replaces a specific transaction with a new one
• Cancel Transaction - Cancels a specific transaction by its ID
• Delete Pending Transactions - Deletes all pending transactions for a specific relayer

Signing Operations

• 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

RPC Operations

• RPC - Performs a JSON-RPC call using the specified relayer

Monitoring

Health Check

• Health - Health routes implementation

Metrics

• 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
• Scrape Metrics - Triggers an update of system metrics and returns the result in plain text format