118 lines
3.9 KiB
Markdown
118 lines
3.9 KiB
Markdown
> ## Documentation Index
|
|
> Fetch the complete documentation index at: https://docs.polymarket.com/llms.txt
|
|
> Use this file to discover all available pages before exploring further.
|
|
|
|
# Quote
|
|
|
|
> Preview fees and estimated output for deposits and withdrawals
|
|
|
|
Get an estimated quote before executing a deposit or withdrawal. Quotes include estimated output amounts, checkout time, and a detailed fee breakdown.
|
|
|
|
## Get a Quote
|
|
|
|
```bash theme={null}
|
|
curl -X POST https://bridge.polymarket.com/quote \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"fromAmountBaseUnit": "10000000",
|
|
"fromChainId": "137",
|
|
"fromTokenAddress": "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
|
|
"recipientAddress": "0x17eC161f126e82A8ba337f4022d574DBEaFef575",
|
|
"toChainId": "137",
|
|
"toTokenAddress": "0xC011a7E12a19f7B1f670d46F03B03f3342E82DFB"
|
|
}'
|
|
```
|
|
|
|
### Request Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| -------------------- | ------ | ------------------------------------------------------------- |
|
|
| `fromAmountBaseUnit` | string | Amount to send in base units (e.g., `"10000000"` for 10 USDC) |
|
|
| `fromChainId` | string | Source chain ID (e.g., `"137"` for Polygon) |
|
|
| `fromTokenAddress` | string | Token contract address on the source chain |
|
|
| `recipientAddress` | string | Destination wallet address to receive funds |
|
|
| `toChainId` | string | Destination chain ID |
|
|
| `toTokenAddress` | string | Token contract address on the destination chain |
|
|
|
|
### Response
|
|
|
|
The quote response includes:
|
|
|
|
| Field | Type | Description |
|
|
| -------------------- | ------ | --------------------------------------- |
|
|
| `estCheckoutTimeMs` | number | Estimated checkout time in milliseconds |
|
|
| `estInputUsd` | number | Estimated input value in USD |
|
|
| `estOutputUsd` | number | Estimated output value in USD |
|
|
| `estToTokenBaseUnit` | string | Estimated output amount in base units |
|
|
| `quoteId` | string | Unique identifier for this quote |
|
|
| `estFeeBreakdown` | object | Detailed fee breakdown (see below) |
|
|
|
|
### Fee Breakdown
|
|
|
|
The `estFeeBreakdown` object contains:
|
|
|
|
<ResponseField name="gasUsd" type="number">
|
|
Gas fee in USD
|
|
</ResponseField>
|
|
|
|
<ResponseField name="appFeeLabel" type="string">
|
|
Label of the app fee
|
|
</ResponseField>
|
|
|
|
<ResponseField name="appFeePercent" type="number">
|
|
App fee as a percentage of the total amount
|
|
</ResponseField>
|
|
|
|
<ResponseField name="appFeeUsd" type="number">
|
|
App fee in USD
|
|
</ResponseField>
|
|
|
|
<ResponseField name="fillCostPercent" type="number">
|
|
Fill cost as a percentage of the total amount
|
|
</ResponseField>
|
|
|
|
<ResponseField name="fillCostUsd" type="number">
|
|
Fill cost in USD
|
|
</ResponseField>
|
|
|
|
<ResponseField name="maxSlippage" type="number">
|
|
Maximum potential slippage as a percentage
|
|
</ResponseField>
|
|
|
|
<ResponseField name="minReceived" type="number">
|
|
Minimum amount received after slippage
|
|
</ResponseField>
|
|
|
|
<ResponseField name="swapImpact" type="number">
|
|
Swap impact as a percentage of the total amount
|
|
</ResponseField>
|
|
|
|
<ResponseField name="swapImpactUsd" type="number">
|
|
Swap impact in USD
|
|
</ResponseField>
|
|
|
|
<ResponseField name="totalImpact" type="number">
|
|
Total impact as a percentage of the total amount
|
|
</ResponseField>
|
|
|
|
<ResponseField name="totalImpactUsd" type="number">
|
|
Total impact cost in USD
|
|
</ResponseField>
|
|
|
|
<Note>
|
|
Quotes are estimates. Actual amounts may vary slightly due to market
|
|
conditions.
|
|
</Note>
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Create Deposit" icon="arrow-right-to-bracket" href="/trading/bridge/deposit">
|
|
Execute a deposit to Polymarket.
|
|
</Card>
|
|
|
|
<Card title="Withdraw" icon="arrow-right-from-bracket" href="/trading/bridge/withdraw">
|
|
Withdraw from Polymarket to another chain.
|
|
</Card>
|
|
</CardGroup>
|