How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenZeppelin Relayers API

Relayers are the core components of the OpenZeppelin Relayer API. They are responsible for executing transactions on behalf of users and providing a secure and reliable way to interact with the blockchain.

OpenZeppelin Relayers API is one of 9 APIs that OpenZeppelin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Relayers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a GitHub repository, a changelog, and rate-limit docs.

This API exposes 20 operations across 15 paths, and defines 102 schemas. It is described by OpenAPI 3.2.0, at version 1.5.0.

Requests are made against the base URL https://defender-api.openzeppelin.com/v2.

20 operations 15 paths 102 schemas 3 DELETE7 GET1 PATCH8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.5.0
Base URL
https://defender-api.openzeppelin.com/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

OpenZeppelin Relayers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth).

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 3 DELETE, 7 GET, 1 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Relayers 20

Relayers are the core components of the OpenZeppelin Relayer API. They are responsible for executing transactions on behalf of users and providing a secure and reliable way to int…

GET
/api/v1/relayers
Relayer routes implementation
listRelayers 2 params → 200400401429500
POST
/api/v1/relayers
Creates a new relayer
createRelayer body → 201400401409500
GET
/api/v1/relayers/{relayer_id}
Retrieves details of a specific relayer by ID
getRelayer 1 param → 200400401404429500
DELETE
/api/v1/relayers/{relayer_id}
Deletes a relayer by ID
deleteRelayer 1 param → 200400401404500
PATCH
/api/v1/relayers/{relayer_id}
Updates a relayer's information based on the provided update request
updateRelayer 1 param body → 200400401404429500
GET
/api/v1/relayers/{relayer_id}/balance
Retrieves the balance of a specific relayer
getRelayerBalance 1 param → 200400401404429500
POST
/api/v1/relayers/{relayer_id}/rpc
Performs a JSON-RPC call using the specified relayer
rpc 1 param body → 200400401404429500
POST
/api/v1/relayers/{relayer_id}/sign
Signs data using the specified relayer
sign 1 param body → 200400401404429500
POST
/api/v1/relayers/{relayer_id}/sign-transaction
Signs a transaction using the specified relayer (Stellar only)
signTransaction 1 param body → 200400401404429500
POST
/api/v1/relayers/{relayer_id}/sign-typed-data
Signs typed data using the specified relayer
signTypedData 1 param body → 200400401404429500
GET
/api/v1/relayers/{relayer_id}/status
Fetches the current status of a specific relayer
getRelayerStatus 1 param → 200400401404429500
POST
/api/v1/relayers/{relayer_id}/transactions
Sends a transaction through the specified relayer
sendTransaction 1 param body → 200400401404429500
GET
/api/v1/relayers/{relayer_id}/transactions/
Lists all transactions for a specific relayer with pagination
listTransactions 3 params → 200400401404429500
GET
/api/v1/relayers/{relayer_id}/transactions/by-nonce/{nonce}
Retrieves a transaction by its nonce value
getTransactionByNonce 2 params → 200400401404429500
DELETE
/api/v1/relayers/{relayer_id}/transactions/pending
Deletes all pending transactions for a specific relayer
deletePendingTransactions 1 param → 200400401404429500
POST
/api/v1/relayers/{relayer_id}/transactions/sponsored/build
Prepares a sponsored (gasless) transaction with fee payments
buildSponsoredTransaction 1 param body → 200400401404429500
POST
/api/v1/relayers/{relayer_id}/transactions/sponsored/quote
Estimates fees for a sponsored (gasless) transaction
quoteSponsoredTransaction 1 param body → 200400401404429500
GET
/api/v1/relayers/{relayer_id}/transactions/{transaction_id}
Retrieves a specific transaction by its ID
getTransactionById 2 params → 200400401404429500
PUT
/api/v1/relayers/{relayer_id}/transactions/{transaction_id}
Replaces a specific transaction with a new one
replaceTransaction 2 params body → 200400401404429500
DELETE
/api/v1/relayers/{relayer_id}/transactions/{transaction_id}
Cancels a specific transaction by its ID
cancelTransaction 2 params → 200400401404429500

Schemas 102

The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are EvmTransactionResponse (19 properties), StellarTransactionResponse (12 properties), SolanaPolicyResponse (11 properties), RelayerSolanaPolicy (11 properties). Each schema is shown below with its type and property counts.

SolanaInstructionSpec
object
Specification for a Solana instruction
3 properties 3 required
SignTransactionRequestParams
object
1 property 1 required
LogLevel
string
RelayerEvmPolicy
object
EVM-specific relayer policy configuration
6 properties
ApiResponse_RelayerStatus
object
5 properties 1 required
GetFeaturesEnabledRequestParams
object
StellarTokenKind
SignTransactionRequest
StellarPolicyResponse
object
Stellar policy response model for OpenAPI documentation
9 properties
SolanaFeeEstimateRequestParams
object
2 properties 2 required
StellarFeeEstimateRequestParams
object
4 properties 1 required
StellarPrepareTransactionRequestParams
object
4 properties 1 required
RelayerSolanaPolicy
object
Solana-specific relayer policy configuration
11 properties
StellarRpcResult
ApiResponse_DeletePendingTransactionsResponse
object
5 properties 1 required
CreateRelayerRequest
object
Request model for creating a new relayer
9 properties 5 required
StellarFeePaymentStrategy
string
Stellar fee payment strategy Determines who pays transaction fees: - User: User must include fee payment to relayer in transaction (for custom RPC methods) - R…
EvmTransactionRequest
object
9 properties 1 required
SolanaSwapStrategy
string
Solana swap strategy
MaskedRpcConfig
object
RPC configuration with masked URL for API responses. This type is used in API responses to prevent exposing sensitive API keys that are often embedded in RPC e…
2 properties 2 required
SolanaAccountMeta
object
Account metadata for a Solana instruction
3 properties 3 required
ApiResponse_TransactionResponse
object
5 properties 1 required
SignDataResponseSolana
object
2 properties 2 required
SignDataResponseEvm
object
4 properties 4 required
StellarAllowedTokensSwapConfig
object
Stellar token swap configuration
4 properties
RelayerNetworkType
string
Network type enum for relayers
JsonRpcResponse_NetworkRpcResult
object
JSON-RPC 2.0 Response structure. Represents a JSON-RPC response that can contain either a result or an error.
4 properties 1 required
SolanaRpcResult
SolanaPolicyResponse
object
Solana policy response model for OpenAPI documentation
11 properties
CreateRelayerPolicyRequest
Policy types for create requests - deserialized based on networktype from parent request
SolanaRpcRequest
WasmSource
Represents different ways to provide WASM code
SolanaTransactionResponse
object
9 properties 4 required
SolanaPrepareTransactionResult
object
5 properties 5 required
JsonRpcRequest_NetworkRpcRequest
JSON-RPC 2.0 Request structure. Represents a JSON-RPC request with proper ID handling: - Some(JsonRpcId) = request with ID - None = explicit null ID or notific…
MemoSpec
StellarSwapStrategy
string
Stellar swap strategy
SignTransactionResult
object
2 properties 2 required
RelayerNetworkPolicyResponse
Policy types for responses - these don't include networktype tags since the networktype is already available at the top level of RelayerResponse
ApiResponse_Vec_RelayerResponse
object
5 properties 1 required
PluginMetadata
object
2 properties
StellarRpcRequest
ApiResponse_String
object
5 properties 1 required
NetworkTransactionRequest
Speed
string
ApiResponse_SignDataResponse
object
5 properties 1 required
RelayerStellarSwapConfig
object
Stellar swap policy configuration
3 properties
SolanaPrepareTransactionRequestParams
object
2 properties 2 required
SolanaFeeEstimateResult
object
2 properties 2 required
StellarPrepareTransactionResult
object
9 properties 6 required
OperationSpec
StellarFeeEstimateResult
object
5 properties 3 required
SignTypedDataRequest
object
2 properties 2 required
SignDataRequest
object
1 property 1 required
TransactionStatus
string
StellarAllowedTokensPolicy
object
Configuration for allowed token handling on Stellar
4 properties 1 required
GetSupportedTokensResult
object
1 property 1 required
AuthSpec
Authorization specification for Soroban operations
GetSupportedTokensItem
object
5 properties 3 required
TransferTransactionResult
object
5 properties 5 required
EncodedSerializedTransaction
string
EvmRpcRequest
TransferTransactionRequestParams
object
4 properties 4 required
SignAndSendTransactionRequestParams
object
1 property 1 required
UpdateRelayerRequest
object
5 properties
RelayerSolanaSwapConfig
object
Solana swap policy configuration
4 properties
ContractSource
Represents the source for contract creation
ApiResponse_SignTransactionResponse
object
5 properties 1 required
StellarTransactionRequest
object
9 properties 1 required
SolanaAllowedTokensSwapConfig
object
Solana token swap configuration
4 properties
AssetSpec
ApiResponse_Vec_TransactionResponse
object
5 properties 1 required
RpcConfig
object
Configuration for an RPC endpoint. This struct contains only persistent configuration (URL and weight). Health metadata (failures, pause state) is managed sepa…
2 properties 2 required
EvmPolicyResponse
object
EVM policy response model for OpenAPI documentation
6 properties
StellarTokenMetadata
object
3 properties 3 required
SolanaAllowedTokensPolicy
object
Configuration for allowed token handling on Solana
5 properties 1 required
GetFeaturesEnabledResult
object
1 property 1 required
StellarTransactionResponse
object
12 properties 7 required
JsonRpcId
Represents a JSON-RPC 2.0 ID value. According to the spec, the ID can be a String or Number. When used in Option : Some(id) = actual ID, None = explicit null.
RelayerStellarPolicy
object
Stellar-specific relayer policy configuration
9 properties
EvmRpcResult
SponsoredTransactionBuildRequest
Network-agnostic prepare transaction request parameters for gasless transactions. Contains network-specific request parameters for preparing transactions with…
SolanaTransactionRequest
object
3 properties
ApiResponse_SponsoredTransactionQuoteResponse
object
5 properties 1 required
LogEntry
object
2 properties 2 required
JsonRpcError
object
JSON-RPC 2.0 Error structure. Represents an error in a JSON-RPC response.
3 properties 3 required
SponsoredTransactionQuoteRequest
Network-agnostic fee estimate request parameters for gasless transactions. Contains network-specific request parameters for fee estimation. The network type is…
SignTransactionRequestSolana
object
1 property 1 required
ApiResponse_SponsoredTransactionBuildResponse
object
5 properties 1 required
EvmTransactionDataSignature
object
4 properties 4 required
ApiResponse_BalanceResponse
object
5 properties 1 required
ApiResponse_RelayerResponse
object
5 properties 1 required
SignAndSendTransactionResult
object
3 properties 3 required
JupiterSwapOptions
object
Jupiter swap options
3 properties
DisabledReason
Reason for a relayer being disabled by the system This represents persistent state, converted from HealthCheckFailure when disabling
PaginationMeta
object
3 properties 3 required
GetSupportedTokensRequestParams
object
SignTransactionRequestStellar
object
1 property 1 required
SignTransactionResponseSolana
object
2 properties 2 required
SolanaFeePaymentStrategy
string
Solana fee payment strategy Determines who pays transaction fees: - User: User must include fee payment to relayer in transaction (for custom RPC methods) - Re…
SignTransactionResponseStellar
object
2 properties 2 required
EvmTransactionResponse
object
19 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openzeppelin-relayers-api-openapi.yml Raw ↑

Other APIs OpenZeppelin publishes across the network.

OpenZeppelin Monitor API
OpenZeppelin Contracts API Reference
OpenZeppelin Health API
OpenZeppelin Metrics API
OpenZeppelin Networks API
OpenZeppelin Notifications API
OpenZeppelin Plugins API
OpenZeppelin Signers API
Where this information came from

This is an independent, third-party profile of OpenZeppelin Relayers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.