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.1.0, at version 1.5.0.
Requests are made against the base URL https://defender-api.openzeppelin.com/v2.
The identity and technical contract details declared by the specification.
CreateRelayerPolicyRequest
Policy types for create requests - deserialized based on networktype from parent request
SignAndSendTransactionResult
object
3 properties
3 required
RelayerSolanaSwapConfig
object
Solana swap policy configuration
4 properties
ApiResponse_BalanceResponse
object
5 properties
1 required
RelayerEvmPolicy
object
EVM-specific relayer policy configuration
6 properties
UpdateRelayerRequest
object
5 properties
SignDataRequest
object
1 property
1 required
SolanaTransactionResponse
object
9 properties
4 required
RelayerNetworkType
string
Network type enum for relayers
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
ApiResponse_SponsoredTransactionQuoteResponse
object
5 properties
1 required
TransferTransactionRequestParams
object
4 properties
4 required
StellarPolicyResponse
object
Stellar policy response model for OpenAPI documentation
9 properties
SolanaAllowedTokensPolicy
object
Configuration for allowed token handling on Solana
5 properties
1 required
SolanaAccountMeta
object
Account metadata for a Solana instruction
3 properties
3 required
CreateRelayerRequest
object
Request model for creating a new relayer
9 properties
5 required
StellarFeeEstimateResult
object
5 properties
3 required
SolanaPrepareTransactionRequestParams
object
2 properties
2 required
SolanaInstructionSpec
object
Specification for a Solana instruction
3 properties
3 required
SolanaPolicyResponse
object
Solana policy response model for OpenAPI documentation
11 properties
SignTransactionRequestParams
object
1 property
1 required
SponsoredTransactionBuildRequest
Network-agnostic prepare transaction request parameters for gasless transactions. Contains network-specific request parameters for preparing transactions with…
StellarFeeEstimateRequestParams
object
4 properties
1 required
RelayerStellarSwapConfig
object
Stellar swap policy configuration
3 properties
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…
TransferTransactionResult
object
5 properties
5 required
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
WasmSource
Represents different ways to provide WASM code
SolanaPrepareTransactionResult
object
5 properties
5 required
EvmPolicyResponse
object
EVM policy response model for OpenAPI documentation
6 properties
ApiResponse_String
object
5 properties
1 required
SolanaTransactionRequest
object
3 properties
GetSupportedTokensRequestParams
object
ApiResponse_Vec_RelayerResponse
object
5 properties
1 required
ApiResponse_Vec_TransactionResponse
object
5 properties
1 required
StellarAllowedTokensPolicy
object
Configuration for allowed token handling on Stellar
4 properties
1 required
ApiResponse_SignDataResponse
object
5 properties
1 required
EvmTransactionRequest
object
9 properties
1 required
GetFeaturesEnabledResult
object
1 property
1 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…
StellarTransactionRequest
object
9 properties
1 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.
GetSupportedTokensItem
object
5 properties
3 required
StellarTokenMetadata
object
3 properties
3 required
AuthSpec
Authorization specification for Soroban operations
SignDataResponseSolana
object
2 properties
2 required
DisabledReason
Reason for a relayer being disabled by the system This represents persistent state, converted from HealthCheckFailure when disabling
LogEntry
object
2 properties
2 required
SignTransactionRequestSolana
object
1 property
1 required
SponsoredTransactionQuoteRequest
Network-agnostic fee estimate request parameters for gasless transactions. Contains network-specific request parameters for fee estimation. The network type is…
ApiResponse_RelayerStatus
object
5 properties
1 required
GetFeaturesEnabledRequestParams
object
StellarAllowedTokensSwapConfig
object
Stellar token swap configuration
4 properties
ApiResponse_RelayerResponse
object
5 properties
1 required
RelayerNetworkPolicyResponse
Policy types for responses - these don't include networktype tags since the networktype is already available at the top level of RelayerResponse
PluginMetadata
object
2 properties
JupiterSwapOptions
object
Jupiter swap options
3 properties
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
ApiResponse_DeletePendingTransactionsResponse
object
5 properties
1 required
EvmTransactionResponse
object
19 properties
6 required
StellarSwapStrategy
string
Stellar swap strategy
StellarPrepareTransactionResult
object
9 properties
6 required
StellarPrepareTransactionRequestParams
object
4 properties
1 required
EvmTransactionDataSignature
object
4 properties
4 required
SignTransactionRequestStellar
object
1 property
1 required
SolanaSwapStrategy
string
Solana swap strategy
SignTransactionResult
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
SignDataResponseEvm
object
4 properties
4 required
ApiResponse_TransactionResponse
object
5 properties
1 required
RelayerSolanaPolicy
object
Solana-specific relayer policy configuration
11 properties
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…
ApiResponse_SponsoredTransactionBuildResponse
object
5 properties
1 required
EncodedSerializedTransaction
string
SignTypedDataRequest
object
2 properties
2 required
ContractSource
Represents the source for contract creation
StellarTransactionResponse
object
12 properties
7 required
SolanaFeeEstimateResult
object
2 properties
2 required
RelayerStellarPolicy
object
Stellar-specific relayer policy configuration
9 properties
SignTransactionResponseSolana
object
2 properties
2 required
GetSupportedTokensResult
object
1 property
1 required
SignAndSendTransactionRequestParams
object
1 property
1 required
PaginationMeta
object
3 properties
3 required
NetworkTransactionRequest
ApiResponse_SignTransactionResponse
object
5 properties
1 required
SignTransactionResponseStellar
object
2 properties
2 required
SolanaAllowedTokensSwapConfig
object
Solana token swap configuration
4 properties
SolanaFeeEstimateRequestParams
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs OpenZeppelin publishes across the network.
