Aggregator API
The Minswap Aggregator API provides direct access to Minswap's aggregation functionality for partners who want to implement their own interface and control the trading logic.
Currency code to get ADA price in. Common values: usd, eur, jpy.
usdPossible values: Current ADA price and 24-hour change in requested currency
The requested currency code in lowercase Example: "usd", "eur", "gbp"
usdCurrent ADA price and 24-hour change in requested currency
Cardano wallet address to query
- Supports both Cbor and Hex format addresses
- Will be normalized to Cbor format in response
addr1...If true, all token balances are returned as decimal strings (e.g., "1.5" ADA), not the smallest unit (e.g., "1500000" lovelace). If false or omitted, balances are in smallest unit.
Detailed wallet balance information including ADA and native tokens
The wallet address in cbor format Example: "addr1..."
addr1...ADA balance.
- 1 ADA = 1,000,000 lovelace
- Returned as string to handle large numbers accurately Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
5000000Minimum required ADA for the wallet. This represents the minimum ADA required to hold native tokens due to the Cardano protocol's UTxO rules. Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Whether amount_in_decimal is enabled or not
Detailed wallet balance information including ADA and native tokens
Search query string to match against:
- Token name (e.g., "Minswap")
- Token ticker (e.g., "MIN")
- Policy ID Empty string returns all tokens (subject to other filters)
minWhen true, returns only tokens verified by Minswap
- true: Only verified tokens
- false: All tokens including unverified ones
trueOptional list of specific token_ids to fetch Format: Array of "" strings Example: ["29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e"]
["29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e"]Pagination cursor from previous response
Token search results with pagination information
Pagination cursor for the next page
Token search results with pagination information
Amount of input token.
- If amount_in_decimal is true: amount is a decimal string (e.g., "1.5" ADA)
- If amount_in_decimal is false or omitted: amount is in the smallest unit (e.g., "1500000" lovelace) For ADA: 1 ADA = 1,000,000 lovelace. For other tokens: amount * (10 ^ decimals). Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA or tokens
- "1000000" (with amount_in_decimal=false) means 1 ADA or token with 6 decimals
Input token identifier:
- For ADA: use "lovelace"
- For other tokens: use "" format Example: "29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e" for MIN token
lovelaceOutput token identifier:
- For ADA: use "lovelace"
- For other tokens: use "" format Must be different from token_in
29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494eMaximum acceptable slippage percentage:
- Examples: 0.5 means 0.5% slippage tolerance
- Used to calculate min_amount_out
0.5Control whether multi-hop swaps are allowed:
- true: Allow routing through multiple pools to find best price
- false: Only allow direct swaps through a single pool
Multi-hop swaps can often provide better prices by routing through intermediate tokens, but may have higher total fees due to multiple swaps. Example: ADA -> MIN -> iUSD might be more efficient than direct ADA -> iUSD
Partner identifier for tracking and analytics:
- Optional string to identify the partner integration
- Used for volume tracking and potential fee sharing programs
If true, the amount field is interpreted as a decimal string (e.g., "1.5" ADA), not the smallest unit (e.g., "1500000" lovelace). If false or omitted, amount is in smallest unit.
Successful route estimation response containing detailed information about:
- Token amounts and minimums
- Fee breakdowns (LP, DEX, and aggregator fees)
- Price impact
- Detailed routing paths through different DEX protocols
Input token identifier (matches request) Example: "lovelace" for ADA
Output token identifier (matches request) Example: "29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e" for MIN
Total input amount for the swap. Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Expected output amount This is the estimated amount before slippage Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Minimum output amount considering slippage Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Total LP fees across all pools in the route Sum of all lp_fee values from individual paths Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Total DEX protocol fees across all pools in lovelace Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Total required ADA deposits for output tokens Required by Cardano protocol for holding native tokens Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Average price impact percentage across all pools Lower is better, high values indicate significant market impact Example: 0.5 means 0.5% price impact
Aggregator service fee amount Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Aggregator fee percentage Example: 0.5
Whether amount_in_decimal is enabled or not
Successful route estimation response containing detailed information about:
- Token amounts and minimums
- Fee breakdowns (LP, DEX, and aggregator fees)
- Price impact
- Detailed routing paths through different DEX protocols
Cardano wallet address that will:
- Provide the input tokens
- Pay transaction fees
- Receive output tokens
Minimum acceptable output amount Must be greater than or equal to the min_amount_out from the /estimate response to ensure price protection Examples:
- "1.5" (with amount_in_decimal=true) means 1.5 ADA
- "1000000" (with amount_in_decimal=false) means 1 ADA
Optional list of preferred UTxO inputs to use when building the transaction.
If true, the amount in the estimate is interpreted as a decimal string (e.g., "1.5" ADA), not the smallest unit (e.g., "1500000" lovelace). If false or omitted, amount is in smallest unit.
Successfully built unsigned transaction The returned CBOR can be signed by the sender's wallet
Unsigned transaction in CBOR format This can be:
- Signed using the sender's wallet
- Submitted to /finalize-and-submit-tx with witness data
Example: "84a400..." (hex-encoded CBOR)
Successfully built unsigned transaction The returned CBOR can be signed by the sender's wallet
Unsigned transaction CBOR from /build-tx response Must be the exact CBOR string received, unmodified Example: "84a400..." (hex-encoded CBOR)
Witness data containing the transaction signature Generated by the sender's wallet when signing Must be hex-encoded Example: "a100..." (hex-encoded witness data)
Transaction successfully submitted to the network The transaction will be processed in the next available block
Transaction ID (hash) for tracking Can be used to:
- Monitor transaction status
- Look up transaction on block explorers Example: "1abc..." (hex-encoded transaction hash)
Transaction successfully submitted to the network The transaction will be processed in the next available block
Cardano wallet address to query pending orders for Must be in bech32 format Example: "addr1..."
If true, all token amounts are returned as decimal strings (e.g., "1.5" ADA), not the smallest unit (e.g., "1500000" lovelace). If false or omitted, amounts are in smallest unit.
Successfully retrieved pending orders Returns an empty array if no pending orders exist
Whether amount_in_decimal is enabled or not
Successfully retrieved pending orders Returns an empty array if no pending orders exist
Cardano wallet address that:
- Originally created the orders
- Will receive refunded tokens
Must be in bech32 format Example: "addr1..."
Successfully built unsigned cancellation transaction The returned CBOR can be signed by the sender's wallet
Unsigned transaction in CBOR format This can be:
- Signed using the sender's wallet
- Submitted to /finalize-and-submit-tx with witness data
Example: "84a400..." (hex-encoded CBOR)
Successfully built unsigned cancellation transaction The returned CBOR can be signed by the sender's wallet
Last updated