API (Order-Router)

Haystack Order Router API specifications for fetching quotes and executing swaps.

Fetch the Haystack quote for a given swap.

GET https://hayrouter.txnlab.dev/api/fetchQuote

Path Parameters

Name	Type	Description
chain	String	Chain for the given swap, either mainnet or testnet. The default is mainnet.
algodUri*	String	Algod client URI.
algodToken*	String	Algod client token.
algodPort*	String	Algod port.
amount*	Integer	Swap amount. The input swap amount, if the swap type is fixed-input, or the expected output swap amount, if the swap type is fixed-output. The amount is expected to be in base units (not normalized to account for decimals). Eg. an amount of 1000001 for asset ALGO would equate to 1.000001 ALGO (since ALGO is displayed with 6 decimals).
type*	String	Swap type. Either fixed-input or fixed-output.
fromASAID*	Integer	The asset ID of the input asset for the swap (ALGO ID is 0).
toASAID*	Integer	The asset ID of the output asset for the swap (ALGO ID is 0).
apiKey*	String	API key. To obtain a custom API key, reach out to [e-mail].
disabledProtocols	String	List of protocols (comma-delimitied) to disable for routing. Note: Humble is always disabled at this point as it no longer seems to be functioning/maintained. Tinyman isn't composable and should probably be disabled in most cases as well. Valid protocol names are: - Humble - Tinyman - TinymanV2 - Algofi - Pact - Folks - TAlgo
maxDepth	Integer	Path search depth between 1-4.
maxGroupSize	Integer	The max allowable size of the transaction group for the quote to be generated.
optIn	Boolean	set to true to have the returned transactions from fetchExecuteSwapTxns automatically include an opt-in transaction to sign. Whether or not opt-in is necessary is up to the caller to determine. Reduces the group size to allow room.
referrerAddress	String	Algorand address of the referrer, who will receive 25% of the swap fees. The default is the order protocol treasury address.
feeBps	Integer	Output fee basis points charged on output, split 75% / 25% between treasury and referrer. Must be at least 10 (the default, but can be set as high 300).
atomicOnly	String	Guarantee that the swap can be executed using a single transaction group. Either true or false. The default is true.

200: OK The Haystack quote object.

{
  quote: 7681118, // the Haystack quote, in base units of output asset for fixed input quotes, or input asset for fixed output quotes
  profitAmount: 10000, // profit amount, in base units of output asset for fixed input quotes, or input asset for fixed output
  profitASAID: 10458941, // profit asset ID
  usdIn: 1.02, // approximate USD value going 'in'
  usdOut: 1.019, // approximate USD value coming back 'out' (this is more the 'real' impact of a swap)
  userPriceImpact: 0.09, // % impact to user (including fees)
  route: [ // the routing of the swap.
    { 
      percent: 50, 
      path: [ // the order routing for a given route
        {name: 'algofi: 0.3% fee tier', in: {id: 93142139}, out: {id: 10458941}}
      ]
    },
    { 
      percent: 50, 
      path: [
        {name: 'humble: 0.3% fee tier', in: {id: 93142139}, out: {id: 0}},
        {name: 'humble: 0.3% fee tier', in: {id: 0}, out: {id: 10458941}}
      ]
    },
  ],
  quotes: [ // quotes from all DEXes
    { name: 'tinyman: 0.3% fee tier', value: 7671118 },
    { name: 'humble: 0.3% fee tier', value: 6853972 },
    { name: 'algofi: 0.25% fee tier', value: 6109782 },
    { name: 'algofi: 0.75% fee tier', value: 5542608 },
    { name: 'algodex single order: 0% fee tier', value: 1111111 }
  ],
  requiredAppOptIns: [], // application IDs required to be opted into for swap
  txnPayload: { // payload used to generate transactions to execute the given quote
    iv: 'b9d00fbd5e1292772ccf94408d970b5e',
    data: '2f5e907c189013c212ad94709416df71124c83f1153a9949d91e9e30778f3def7fef9736670f2cb3f94d7e6685dfbc0124aa693588df76226518714566fa7d4cca2afbd7a45bf19f2e55111eb5152e1409b59842ea8bb7df4b3b8b9e306ec8abc66a781c1152b10b5fd19b1d7b863d2e7d37400c497f690906c2ee674f453dd2dc7cfeb77b02b010d82a615640d2ecf3b29adf3852d80cd90fb12aca8155ea7966c03b0554cccd11f937f2ed98c53a2a083e6a898325db3c2ecf4f8fa38eb735c05655fef8af959db8b010420d478e2ffda4674e03e002f511a254ec6502805222c774f3cf6d55d2e5dc8135513bea4ac05d98ebf034724b3adfe8ab966d35e4af279979cd777d6fda434e3106fc7f0dff8159b6bcb6ec5c1c608cc13c671b6661b09b6aec9c763b04518beecf0b2e5cf8cbbe7ead459993cbd04163558849b73c17e74c71636c524fc78c5ce1edd90a1500e18365410ad8e8379aac6dc29c20b76377cb7d9290000da747a67dbcbc6e62a425e9a55ee64ad06b61100da4fa7ead7eaceab93194fb38b4173d431b61fac6e1390311e73025efb8d0ff0a3bfcd169acacfe612dc6c0e55fa53eacfb21bbb228d9b469411e63950524b7bf5fa70f2fdb5449a4be8a24b4611b18d594115fa5ee9f662e5dd458f0ff16a961809849a6ef979cf7cb1a16e5eb79ea25d10ad3520cf2bdc8cd51bf824209d081670d469bd52891eceb37801ca3c732e597a84a1acb2548077ade38d9a16102eb596872ddbead3b5dee7f9749e9c8c1201fcc86c68268ce3d6cf60e167703c2df29156736f8578dc08c5da8f67be120318f370a436a4b5f3f8ee0eae53b8fd2549ec2d36a33c1d6ee545a62c8b3b4bb877ec6205ca5ad8e73fe39bbff8bfd04801116cf8b1ecbb55d35be61f8e9bce8556ea5f90c28b0a5a07683ce76b4a7ddbfe1571e7054674f9416fc96740ff66def8b4ad6a1bd0fc1c14e0bd586fb7d077a48309ebeb233c591e7c4b406bcb97037e798f4f35539d8b0b249cc014737909939bc9ac3bc9fde35471dd2b2792874a8131369c2b364467f5d0c3166fc14558137f5d88a09bb6317853b60fb6495da1d051e99aa2aa6efd44978339149e406fa4a6325d732c0897713b542b05ed7009dab8f5dd16ae1e78e93950993167ca1a07296e18cadebee22330e637a9449d440d87fbcde61348de36b668c31ff57c4e953b7b26705bfc98442c300708c88fbe5879d19b0e982f97774b19666c307fe266d11f520c3ab44d23a0345192e618bd749ca8fbd0b2711e728776a2e719f44b74a74a71f6dcf5b51f5229413a6d912f835d5a141859df467bb683268416f15d0431f1053562ba0e487a8d199aa82d4bcc79c7d30adf42f48323c9ca61b7110546db9daaf8c565ea1b47fa3526ed8e3346138a35121d399912ac95947b8c9364edb6dc6dbc765142ba265018db0ba818fa56f098821993853b3920920fce5e4ae0866dd871160d4af8ea308c27b0a08a821e1243336bee41c30929d9a40b5b19ac8740f0a62e1d5ff061ba55e43ca07af9911ef602a02b659c4df8a3e8fa54c1325596f5590814476509e2147d57c4409693e1b23fa5c4ed2cf16e6f528cedc9b45e19ccec9c4ce5a2fd5bcaabe2884b1c4553cb3c58f298f8fe8f411670f504300087f4a7872e9aa89e43286b2a1120ed133217c326a5f74e2d5f5c9187a4875d9691a1e821ecf802debb4161a2a979f7fe02966fdecaa6d320e6b4b39cf7b62e33c7a61af9bb517430263cee57ef1e125fb716a9c621dce945c71dd253fd5ec56525117d2a808def65e51a898f5f641edcafe690607589836e7827abcdd6f6ed13fed1337b3e855d7656a54cd21fe572469c53586eca090dd2aab2433f2853b311462a4f64bd4f9747f1f8ceb0a08b14dcf898c59901a6f98051895e47b91c0c3ad9006e39baab329b8d0fd676bb419f606c3ab44f1ba3a3dea9413461133f9ab281ceeda54291dbffbfdc6feb3a6932518be1d7aaa1490c0110aeea7c4f22e494a842ddb0d28c139d6751f5f68f48ed82d26f3bc344a87fc539dda81b178157e52e472b3dee9f7f191545f700a55dc078468bb10355626f1f35c9baff1e00a35685c2478c8d366835a8576b462a03cd36060b229c856b31243236a5fd11e114524da98bbe4caa8c47b11342000da89acd681226911082b6110e16a87a8e19d5a97962e037b5762919413ecdbe54a78a00dfdbe5a662f3a116fa2a968a0d4fd46e1323739ce0d564a981e38b12101a6027430fb2a648c47dd1854f394de637ac3a10e69aa277b47a0c98824623722fbe1a4ad1b8ba0d6d3faeab3001864846600021c09a1ce6a4676639ad3ce6dc48d9165a1654d6819eb9e75d3c257b944d5c9c84c4340366fa37f421ed88b4dfbee263df56988b31e2d2c8be420318f22544ec650611a65ae3a0926ec09e977190ad1d5e53292f2a18866dae7b322bffcef7642154f89526945405acec54d5cadedc8c02f4318e62337237a9ed47fa9a0f284b0b962e1f792ceec8dda063624e45797cfe013b0edb2423de35da2d47febace7f12abfdff4ae0e48bb79226d03508e2a510357e8b4e171051786930358e976df911a8f45e1d461f38f039a5b35c52204bc05734a470ea2a01e350fdc9c8261a432c07f1cace057f696fbfcd6f4cf79ea826ebecc3853687078daeecbe9080173f9bbebf32cfd769aeb538ba0f8eedbca8750110808338945e9220222f26b244fafe8a648933fabd028b6aa832c06eb1b602444cc9597be6fa435cb580700f815724f880c4b5b390000c631e6d6508fb2dbcccc5ee6ad10f5258f66a8109b6197a17a868be9e8e262fa26fb5e5508f690264394349e5e6951c4d85198e9235b2dc940753c77588e4a43f345acef6c7e2fec6b175c47230ec0c34369d220a9580f216d465125be8483038a730e6adac6f5536f36be5e406a23411485e131f03756e3754a0cc5d1aad50ebbe5a6c64f85cda4f0c59bb3b274c9897f94a458bc194a1fa5313da05866b8a764186d31963012ec6799053219668e6ba7b0c9d3bc9c24270ef097f01871d08a6edc7f5d70e67b8a4160c8730d5a7bd0349146b96f65d7e23a152014b1754b205433da7e4c78e12e885c1f10bd9f08fa0e3fc31bee7b90f33afe0e5de054905a8fe81e17e0f9f87f7ff599b2d7d1da47e975c71ddd2e48ac73c166c9748763e1217e85616bb40c77d91066148ec0b9df48087e8d160f0d0421f7fc51386903d0635a2b0aa82269642e4d5a40c0b8613b62cb7784a133bc588dc811ccc984b5f8534e7e53fcbe7f49397f6f4cee1c5fcad4e2ae87a1362e0423dc9daaf5ec3cab2863bd7b76e09fb01f34cd9f87ba4a339df0b38bb38d28b0aa69a8f3a465cec3709fdf4feac2fe494d347bc09580245c1d2fc606110d437011bf37a330577625ab2b1035493555b7995a16eb18079983db624390a54b90b8816e8654a776d4ab1eedc7c15bd6b84d8a11e8e950daf85d60e9773ae91fd28043fc2fc86933f8b91e218c0f15483454ca242a61857fc6723951cb43509203fb1af152b25210914495d4e4098a0885a9d45559a3b28557d6d427c605d482cfd659b51056386c50cabd2bf163aa7806173e21b2d7a4144e0ed655cad42c03461e9e313a6786d9f591f39b99151fbc587dd8468dd1e5450be30f47a0322f3ec8c6af509bd89da6799dbf47ab9b84ec102d555130432838a2a0e129384a7c4c1f369d44466a680a1773ff92916506c75365915070f54866904a48ae3e4fcad3ad2bc4abc6e65682972470e55cda55ea603cb754f16017d2fc268d066ca2a0b03c0d99c9f07bde8ae1449b873882ea69a3b8764abb0a26d9f5e4368ecd07f0cd158724e961435baf3e8e5197fc2b1af906aa7d5fdc98fb12da8cd128fe7fbcce5e71dcbc657b84cbf02cc086358f3bb949db24b6c292df8831ba93d25059a71627ab73e61a7cbefb15c348f1159e18c60766335d4283116ac08925a9135f75cc4caa017d8b936498c1de48441efcfc8647d80d3c68c4cd74aae1cf6c2fd114a1c22b8b68859927bb6ec0e5baedffe21298479892eb73fdc8352b665c59ff69dcb979ca5d757dc438a4bdf4fd79bcda27b71c556563a8a2ef7e98b2e5705bb3732a4f4944a8114379bcbb313bf6930046cdea51f724ea3c5d4fd06a364a8c79bfa5a97d75e7367b6f1c30dbfc6e0d984bdaacb982e1349c3066336212966dd17ee87668ba1beb83c1831933aff7e5e2c16d5dac1be51326af8391a63cf1a11d3c0f456bf653aebd25eb39278264deb386fe071e5a8c51e074d6c9621feda4fd6a66e870abe86d78704a9eecf76b1938bac47de2e1a15f5a6e4d98a244a4ad87199f6453c5f0442d79d0fb792c5b3d805b1515cd3755e3b6f02e6e11073a8a41f8ff14a2452541917d1192d097a87cec1af6c366420238c74be9497f9324d8e1b73b8daa42d2e9c279a5d7d707011845ce24b258ed48b980629818a64727f31aee0a5b3e11f34937c20f6c775829433adf53ba771f9231214c11aa0edaa7d0b32d7f79116f1a8ba8153f91e6a2b626cfa4682222b97d71c94c387a7ed2819027a76d9196b4e7148f73ec0a2b71302683ce229c1d8883123a1713dea83a2528fbce126194c43db8e2047fe47f1c7deb2a1d1fe4613c5bb9a5a6515e447c26949dc6a90bbcb4a88c9754a6825a1714307775f2e5e088a3ad5f6d74cbb92a5d039c067085fc65a48b00d54e8ca444948623a82649edbeba5b2e8c974c887630a89ed1a8dc90c864a473d828f322605232b2d54416e12ed503b84f540b7340752a2f900701e8e865a317fad1734381bb91ab294d4bba64f743c54dd7e75a5bdc1a598d5aec89d98d74731f3c52136672b3c42fa434c837f6e0c99da02c776e31a6a8111f8b4946a7b40cbe50340ce7f28ec59548dab7e1bcad49f43bc010d5ef220adb1eb3bb953fdef6d87983f83af42a7863586198e376c226e85348088a603d1c4cf434ecc06ebde8072a74dd4f43197a7935dab1c9401f227b28a6f7e42cf4aaa4f1958cc336c3143afaae9e1de891cdc7616ff3a62dc19d774813f88e5baf3943294ffdbe935f7487f09a05adb931e4ecfb541c14292b8fb4a46b672917b4ca7fa443404269f96baceb4d4b9b16e1f8deb9d7143f138784b1ee2b457368a60118a538fe680efba36566a464033ee8ee17b7720bada523d4deef40a89a93892f74a2d835cfe0e65b36e052fb764c0e8cdcae3ad512b1884bf50895a4e2ffbf7b9d3b93b9ef56177c98bc1da256bd62ef6b8707a3b94c42bab2297e40a081edfa38cdbee8897f91eb3e1b2de30201cad5cfe9c1c1f2e8dbd0af8ae837c2d4c268e14d1912fdcde4802254b5b00f68f64009437226ede18fac758e43c94c7b51e9e252da3ea4d4fcfd9ac8add428741560ce44daf1e0c3ce352ab22da9a4768780c816188a2d245e5e4624103fcc78f6b17206e3b3e49f5eee8ae8ad0d9c9f01805b13c93f3a0df93a7145ab40ac10d3e4e8f66d9d1ca812ac6a2b9cd586a48259902ad287d1f472e1ec9abc48eb7530695e47ae35c3afbfb884db175797d12ec94979ffb1e535cff9ec0e41625bc112a79a06af73d2cff31692d150b4d43aaf63c57645dd80f9b451c45f887a70aee2f37ccbf0ec2b1c26ba2da9e8ea46bd4fd72d3dd61baa0b02663121b1196c0ff54608ce1fdd19e89dbf826f48493ebacdd6925b5c4f01dc7168e0c69d14c1720ffcd906674735dfb550e4bf9e61d2a216b26316aab6eae03cc4a1f4455253de0c05efd27403953f6f81da5affbc4f1beba50ed1f835a96699010ca10ef5bc3ea8c4ce02fe6f8ab72f65115ccbec9268c75c297a2159566eea37ef26e0fd742d3183ba10987c88162bc19fd1a3a988ec93e264333321f500333d75d04a73d73b137f0690dcb3f413f7363c9092eca3445cc90897979a2b727ecc499e09e9a63d3e646c757f7c'
  }
}

400: Bad Request One of the input params does not match validation criteria.

429: Too Many Requests Rate limit exceeded. Consider using an API key.

500: Internal Server Error An exception was thrown and not gracefully handled.

Fetch the transaction group for a given Haystack quote.

POST https://hayrouter.txnlab.dev/api/fetchExecuteSwapTxns

The transaction group does not handle any required asset or application opt-ins, or redeeming excess amounts (eg. from Tinyman).

Request Body

Name	Type	Description
address*	String	Algorand address of swapper.
txnPayloadJSON*	Object	Txn payload from the Haystack quote (value at txnPayload key)
slippage*	Float	Slippage threshold percentage for the swap (the swap will fail if the prices changes unfavorable by more than this percentage).
apiKey*	String	API key (required). To obtain a custom API key with a custom rate limit, reach out to [e-mail].

200: OK The transaction group to execute the swap.

{
  txns: [ // transactions to execute for the swap. See example JS below on how to submit for execution.
    {
      data: 'iqNhbXTOAA9CQKNmZWXNA+iiZnbOAWef2qNnZW6sdGVzdG5ldC12MS4womdoxCBIY7UYpLPITsgQ8i1PEIHLD3HwWaesIN7GL39w5Qk6IqNncnDEII0OHHrGPQ0tL2DhrwwLEE/1+eM2lZr9vZHDP5x+NI4iomx2zgFno8KjcmN2xCCZUpdhqjdH47PDTmfqHIjfZd4ijz83l+dvplWNz8XaFaNzbmTEIB2hd2WGGD0Mxk8kfO4Bk3bDDwiJYV2uktGIVf1FLu8MpHR5cGWjcGF5',
      group: 'jQ4cesY9DS0vYOGvDAsQT/X54zaVmv29kcM/nH40jiI=',
      logicSigBlob: false
    },
    {
      data: 'jqRhcGFhmcQELdh61sQIAAAAAAAAAADEAQDEAQHEAQHEAQHECAAAAAAAD0JAxAgAAAAAAAAAAcQDAAEDpGFwYXOSAM4FTj2ypGFwYXSRxCAfxS3Ey1MJx9IK16puGnVVuG16xMYFbAgGUsFVdLFBTqRhcGZhkc4FgcqPpGFwaWTOBjFF86NmZWXNLuCiZnbOAWef2qNnZW6sdGVzdG5ldC12MS4womdoxCBIY7UYpLPITsgQ8i1PEIHLD3HwWaesIN7GL39w5Qk6IqNncnDEII0OHHrGPQ0tL2DhrwwLEE/1+eM2lZr9vZHDP5x+NI4iomx2zgFno8Kkbm90ZcQSMC45MDc2NDIxNzAyNTA2MDU3o3NuZMQgHaF3ZYYYPQzGTyR87gGTdsMPCIlhXa6S0YhV/UUu7wykdHlwZaRhcHBs',
      group: 'jQ4cesY9DS0vYOGvDAsQT/X54zaVmv29kcM/nH40jiI=',
      logicSigBlob: false
    }
  ]
}

/* EXAMPLE JS TO SUBMIT TXN GROUP

const account = algosdk.mnemonicToSecretKey('<insert_secret_key>')

const signedTxns = response.txns.map((txn) => {
  if (txn.logicSigBlob !== false) {
    return txn.logicSigBlob
  } else {
    let bytes = new Uint8Array(Buffer.from(txn.data, 'base64'))
    const decoded = algosdk.decodeUnsignedTransaction(bytes)
    return algosdk.signTransaction(decoded, account.sk).blob
  }
})
const algod = new algosdk.Algodv2(token, uri, '')
const {txId} = await algod.sendRawTransaction(signedTxns).do();
*/

400: Bad Request One of the input params does not match validation criteria.

429: Too Many Requests Rate limit exceeded. Consider using an API key.

500: Internal Server Error An exception was thrown and not gracefully handled.