> For the complete documentation index, see [llms.txt](https://docs.orda.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.orda.network/api-reference/api-reference/models.md).

# Models

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Orda API","version":"1.1.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error type identifier"},"message":{"type":"string","description":"Human-readable error message"},"correlationId":{"type":"string","description":"Request correlation ID for debugging"}}}}}}
```

## The QuoteRequest object

```json
{"openapi":"3.0.3","info":{"title":"Orda API","version":"1.1.0"},"components":{"schemas":{"QuoteRequest":{"type":"object","required":["fromChain","fromToken","fromAddress","intent"],"properties":{"fromChain":{"type":"string","description":"Source blockchain chain ID"},"fromToken":{"type":"string","description":"Source token contract address"},"fromAddress":{"type":"string","description":"Source wallet address"},"intent":{"type":"object","required":["method","value"],"properties":{"method":{"type":"string","enum":["usd","fromAmount","toAmount"],"description":"Quote calculation method"},"value":{"type":"string","description":"Amount value for the specified method"}}},"recipientId":{"type":"string","description":"The ID of an existing recipient to send funds to (provide either this OR settlementDetails)"},"settlementDetails":{"type":"object","description":"Inline settlement details (provide either this OR recipientId)","properties":{"toChain":{"type":"string","description":"Destination blockchain chain ID"},"toToken":{"type":"string","description":"Destination token contract address"},"toAddress":{"type":"string","description":"Destination wallet address"}}}}}}}}
```

## The QuoteResponse object

```json
{"openapi":"3.0.3","info":{"title":"Orda API","version":"1.1.0"},"components":{"schemas":{"QuoteResponse":{"type":"object","properties":{"message":{"type":"string","description":"Status message"},"transactionId":{"type":"string","description":"Transaction ID"},"quote":{"type":"object","nullable":true,"description":"Detailed provider quote. Returned on the routed (provider/bridge) path only; omitted on the direct-transfer path (when `providerQuoteDetails.isDirectTransfer` is `true`).","properties":{"provider":{"type":"string","description":"Provider used for the transaction"},"subProvider":{"type":"string","description":"Sub-provider used (e.g., specific DEX or bridge within an aggregator)","nullable":true},"providerRequestId":{"type":"string","description":"Provider-specific request ID"},"fromToken":{"type":"object","properties":{"address":{"type":"string","description":"Token contract address"},"decimals":{"type":"integer","description":"Token decimals"},"symbol":{"type":"string","description":"Token symbol"},"price":{"type":"number","description":"Token price in USD"},"chainId":{"type":"integer","description":"Chain ID where this token is located"}}},"toToken":{"type":"object","properties":{"address":{"type":"string","description":"Token contract address"},"decimals":{"type":"integer","description":"Token decimals"},"symbol":{"type":"string","description":"Token symbol"},"price":{"type":"number","description":"Token price in USD"},"chainId":{"type":"integer","description":"Chain ID where this token is located"}}},"fromAmount":{"type":"string","description":"Amount in source token"},"toAmount":{"type":"string","description":"Amount in destination token"},"fromAddress":{"type":"string","description":"Source wallet address"},"toAddress":{"type":"string","description":"Destination wallet address"},"estimatedDuration":{"type":"integer","description":"Estimated duration in minutes"},"fees":{"type":"object","properties":{"bridge":{"type":"object","description":"Bridge/relayer fee details","properties":{"amount":{"type":"string","description":"Fee amount in smallest token units"},"token":{"type":"string","description":"Token symbol for the fee"}}},"gas":{"type":"object","description":"Gas fee details","properties":{"amount":{"type":"string","description":"Gas fee amount in smallest token units"},"token":{"type":"string","description":"Token symbol for the gas fee"}}},"integrator":{"type":"string","description":"Integrator fee"},"maxSlippage":{"type":"number","nullable":true,"description":"Maximum slippage tolerance as a decimal (e.g., 0.01 for 1%). Null if not applicable."}}}}},"approvalTxParams":{"type":"object","nullable":true,"description":"ERC-20 approval transaction the client must sign before the main transaction. Returned on the routed (provider/bridge) path only; omitted on the direct-transfer path. May also be absent when no approval is required.","properties":{"from":{"type":"string","description":"Source address"},"to":{"type":"string","description":"Token contract address"},"gas":{"type":"string","description":"Gas limit"},"data":{"type":"string","description":"Transaction data"},"value":{"type":"string","description":"Transaction value"},"nonce":{"type":"integer","description":"Transaction nonce"}}},"transactionRequest":{"type":"object","properties":{"from":{"type":"string","description":"Source address"},"to":{"type":"string","description":"Destination address"},"data":{"type":"string","description":"Transaction data"},"value":{"type":"string","description":"Transaction value"},"chainId":{"type":"integer","description":"Chain ID"},"requestId":{"type":"string","description":"Request ID"},"gas":{"type":"string","description":"Gas limit"},"gasPrice":{"type":"string","description":"Gas price in hex wei. Present on the direct-transfer path."},"nonce":{"type":"string","description":"Sender account nonce in hex. Present on the direct-transfer path."},"maxFeePerGas":{"type":"string","description":"Maximum fee per gas"},"maxPriorityFeePerGas":{"type":"string","description":"Maximum priority fee per gas"}}},"feeTxParams":{"type":"object","nullable":true,"description":"Recipient-fee transaction the client must sign and broadcast in addition to the main transfer. Returned on the direct-transfer path only (when `providerQuoteDetails.isDirectTransfer` is `true`), and only when the organization has a non-zero recipient fee and a configured fee wallet. Null otherwise.","properties":{"from":{"type":"string","description":"Source address"},"to":{"type":"string","description":"Recipient of the transfer (fee wallet for native transfers, token contract address for ERC-20 transfers)"},"gas":{"type":"string","description":"Gas limit (hex-encoded)"},"gasPrice":{"type":"string","description":"Gas price (hex-encoded)"},"data":{"type":"string","description":"Transaction data ('0x' for native transfers, encoded ERC-20 transfer call otherwise)"},"nonce":{"type":"string","description":"Transaction nonce (hex-encoded)"},"value":{"type":"string","description":"Transaction value, hex-encoded (transfer amount for native transfers, '0x0' for ERC-20 transfers)"},"chainId":{"type":"integer","description":"Chain ID the fee transaction targets"}}},"providerQuoteDetails":{"type":"object","description":"Summary of the resolved quote, including which path produced it. Present on both the routed and direct-transfer paths.","properties":{"fromAmount":{"type":"string","description":"Resolved source amount in the source token's smallest unit"},"toAmount":{"type":"string","description":"Resolved destination amount in the destination token's smallest unit"},"isDirectTransfer":{"type":"boolean","description":"Whether the quote resolved to a same-chain direct transfer (`true`) or a routed provider/bridge transfer (`false`). When `true`, the response includes `transactionRequest` and (conditionally) `feeTxParams` but omits `quote` and `approvalTxParams`."},"provider":{"type":"string","description":"Provider that produced the quote ('Direct' on the direct-transfer path)"},"originalIntent":{"type":"object","description":"Echo of the intent supplied in the quote request","properties":{"method":{"type":"string","enum":["usd","fromAmount","toAmount"]},"value":{"type":"string"}}}}}}}}}}
```
