getPrice (Allowance Holder)

Get the indicative price for a swap using Allowance Holder to set allowances

Query parameters

chainIdintegerRequired>=0

Chain ID. See here for the list of supported chains

Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains

buyTokenstringRequiredformat: "^0x(?!0{40})[a-fA-F0-9]{40}$"

The contract address of the token to buy

sellTokenstringRequiredformat: "^0x(?!0{40})[a-fA-F0-9]{40}$"

The contract address of the token to sell

sellAmountstringRequired

The amount of sellToken in sellToken base units to sell

takerstringOptionalformat: "^0x[a-fA-F0-9]{40}$"

The address which holds the sellToken balance and has the allowance set for the swap

txOriginstringOptionalformat: "^0x[a-fA-F0-9]{40}$"

The address of the external account that started the transaction. This is only needed if taker is a smart contract.

recipientstringOptionalformat: "^0x[a-fA-F0-9]{40}$"

The address to receive the buyToken. If not provided, defaults to the taker address. Not supported for wrap/unwrap operations.

swapFeeRecipientstringOptionalformat: "^\s*0x[a-fA-F0-9]{40}(\s*,\s*0x[a-fA-F0-9]{40})*\s*$"

The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify the swapFeeBps in the request to use this feature. When multiple values are provided, must match length of swapFeeBps.

swapFeeBpsstringOptionalformat: "^\s*\d+(\s*,\s*\d+)*\s*$"

The amount in Bps of the swapFeeToken to charge and deliver to the swapFeeRecipient (supports single or multiple comma-separated values). You must also specify the swapFeeRecipient in the request to use this feature. For security, this field has a default limit of 1000 Bps. If your application requires a higher value, please reach out to us.

swapFeeTokenstringOptionalformat: "^\s*0x(?!0{40})[a-fA-F0-9]{40}(\s*,\s*0x(?!0{40})[a-fA-F0-9]{40})*\s*$"

The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the buyToken or the sellToken. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the swapFeeRecipient and swapFeeBps to charge integrator fees. When multiple values are provided, must match length of swapFeeBps.

The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and `swapFeeBps` to charge integrator fees. When multiple values are provided, must match length of `swapFeeBps`.

tradeSurplusRecipientstringOptionalformat: "^0x[a-fA-F0-9]{40}$"

The address to receive any trade surplus. If specified, this address will receive trade surplus when applicable. Otherwise, the taker will receive the surplus. This feature is only available to selected integrators on a custom pricing plan. In other cases, the surplus will be collected by 0x. For assistance with a custom plan, please contact support.

tradeSurplusMaxBpsintegerOptional1-10000

The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with tradeSurplusRecipient.

gasPricestringOptional

The target gas price (in wei) for the swap transaction. If not provided, the default value is based on the 0x gas price oracle

slippageBpsintegerOptional0-10000Defaults to 100

The maximum acceptable slippage of the buyToken in Bps. If this parameter is set to 0, no slippage will be tolerated. If not provided, the default slippage tolerance is 100Bps

excludedSourcesstringOptional

Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See https://api.0x.org/sources?chainId=<chain_id> with the desired chain’s ID for a full list of sources. Separate multiple sources with a comma

Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See https://api.0x.org/sources?chainId=<chain_id> with the desired chain's ID for a full list of sources. Separate multiple sources with a comma

sellEntireBalanceenumOptionalDefaults to false

If set to true, the taker’s entire sellToken balance will be sold during trade execution. The sellAmount should be the maximum estimated value, as close as possible to the actual taker’s balance to ensure the best routing. Selling more than the sellAmount may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more here.

If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://0x.org/docs/0x-swap-api/advanced-topics/sell-entire-balance).

Allowed values:

Response

Successful response

SwapAllowanceholderGetpriceResponse2000object

SwapAllowanceholderGetpriceResponse2001object

1	import requests
2
3	url = "https://api.0x.org/swap/allowance-holder/price"
4
5	querystring = {"chainId":"1","buyToken":"0xdac17f958d2ee523a2206206994597c13d831ec7","sellToken":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48","sellAmount":"100000000","taker":"0x70a9f34f9b34c64957b9c401a97bfed35b95049e"}
6
7	payload = { "body": {
8	"chainId": 1,
9	"buyToken": "0xdac17f958d2ee523a2206206994597c13d831ec7",
10	"sellToken": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
11	"sellAmount": "100000000",
12	"taker": "0x70a9f34f9b34c64957b9c401a97bfed35b95049e",
13	"txOrigin": "0x5aeda56215b167893e80b4fe645ba6d5bab767de",
14	"recipient": "0x8ba1f109551bD432803012645Ac136ddd64DBA72",
15	"swapFeeRecipient": "0x1111111254fb6c44bac0bed2854e76f90643097d",
16	"swapFeeBps": "25",
17	"swapFeeToken": "0xdac17f958d2ee523a2206206994597c13d831ec7",
18	"tradeSurplusRecipient": "0x742d35cc6634c0532925a3b844bc454e4438f44e",
19	"tradeSurplusMaxBps": 500,
20	"gasPrice": "7000000000",
21	"slippageBps": 100,
22	"excludedSources": "Uniswap_V3,SushiSwap",
23	"sellEntireBalance": "false"
24	} }
25	headers = {
26	"0x-api-key": "0x-api-key",
27	"0x-version": "v2",
28	"Content-Type": "application/json"
29	}
30
31	response = requests.get(url, json=payload, headers=headers, params=querystring)
32
33	print(response.json())

1	{
2	"allowanceTarget": "0x000000000022d473030f116ddee9f6b43ac78ba3",
3	"blockNumber": "20114676",
4	"buyAmount": "100032748",
5	"buyToken": "0xdac17f958d2ee523a2206206994597c13d831ec7",
6	"fees": {
7	"integratorFee": null,
8	"integratorFees": null,
9	"zeroExFee": null,
10	"gasFee": null
11	},
12	"gas": "288095",
13	"gasPrice": "7062490000",
14	"issues": {
15	"allowance": {
16	"actual": "0",
17	"spender": "0x0000000000001ff3684f28c67538d4d072c22734"
18	},
19	"balance": {
20	"token": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
21	"actual": "0",
22	"expected": "100000000"
23	},
24	"simulationIncomplete": false,
25	"invalidSourcesPassed": []
26	},
27	"liquidityAvailable": true,
28	"minBuyAmount": "99032421",
29	"route": {
30	"fills": [
31	{
32	"from": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
33	"to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
34	"source": "SolidlyV3",
35	"proportionBps": "10000"
36	}
37	],
38	"tokens": [
39	{
40	"address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
41	"symbol": "USDC"
42	},
43	{
44	"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
45	"symbol": "USDT"
46	}
47	]
48	},
49	"sellAmount": "100000000",
50	"sellToken": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
51	"tokenMetadata": {
52	"buyToken": {
53	"buyTaxBps": "0",
54	"sellTaxBps": "0",
55	"transferTaxBps": null
56	},
57	"sellToken": {
58	"buyTaxBps": "0",
59	"sellTaxBps": "0",
60	"transferTaxBps": null
61	}
62	},
63	"totalNetworkFee": "2034668056550000",
64	"zid": "0x111111111111111111111111"
65	}

getPrice (Allowance Holder)

Headers

Query parameters

Response

Errors