Skip to main content

GetSwapLimitsOutput

Output from the swap limits endpoint.

input objectrequired

Limits expressed on one side of the swap.

min objectrequired

Unified amount type for all API responses.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000
decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

max object

Unified amount type for all API responses.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000
decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

output objectrequired

Limits expressed on one side of the swap.

min objectrequired

Unified amount type for all API responses.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000
decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

max object

Unified amount type for all API responses.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000
decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

GetSwapLimitsOutput
{
"input": {
"min": {
"amount": "string",
"rawAmount": "1500000000000000000",
"decimals": 0,
"symbol": "string",
"chain": "string"
},
"max": {
"amount": "string",
"rawAmount": "1500000000000000000",
"decimals": 0,
"symbol": "string",
"chain": "string"
}
},
"output": {
"min": {
"amount": "string",
"rawAmount": "1500000000000000000",
"decimals": 0,
"symbol": "string",
"chain": "string"
},
"max": {
"amount": "string",
"rawAmount": "1500000000000000000",
"decimals": 0,
"symbol": "string",
"chain": "string"
}
}
}