# Introduction Project Overview YetAnotherDeFi, or YAD, is a multichain swap router that aggregates liquidity across all dominant blockchains from all leading DeFi liquidity providers. YAD allows swapping 3,500 tokens over seven blockchains at the best rate with the lowest transaction cost. Our decentralized, non-custodial, and censorship-resistant swap technology gives you the freedom to swap and send your money whenever and wherever you want, with no borders and no KYC limits. We’ve developed a gas-optimized smart contract so that you can save your money on transaction fees. Our goal is to provide the widest choice of assets for you to maximize your benefits from every swap. # Key features ## What problems does YAD solve? * **Market diversity**\ There are 300+ DEXs across seven different blockchains operating in DeFi market, each offering different rates and liquidity models. Traders need to constantly monitor and compare multiple DEXs to find the best rate. * **Fragmented liquidity**\ Swaps with high volumes or exotic token swaps require deep liquidity, otherwise the swap will cause significant price impact and reduce the outcome. Traders can not use all liquidity locked in the blockchain because it is fragmented across many different pools. * **High network fees**\ For small orders, transaction execution fees can significantly reduce the final amount the user receives. Traders need to weigh both the network gas fees and rate differences when comparing various DEXs. ## How does YAD solve these problems? * **Market aggregation** \ YAD collects live rates across all available markets, plus YAD uses RFQ mechanics to propose the best rate for the desired trading pair. * **Order splitting**\ Large orders can be split up among liquidity pools to reduce their price impact, ensuring the trader a better execution rate. * **Order routing**\ YAD aggregates DeFi liquidity pools with different market models and depths in order to find the optimal order route with the best possible execution rate. When the overall market depth for the desired swap pair is low, this route can traverse several pools to provide higher liquidity. * **Gas-optimized smart contracts**\ YAD has developed innovative gas-optimized smart contracts so traders can save money on transaction fees. * **Slippage protection**\ Users trading on YAD are able to set their own maximum acceptable slippage, known as slippage tolerance. If the execution rate exceeds this set limit, the trade will be reverted. ## Supported chains, tokens and wallets ### Chains Here's the list of blockchain networks that YAD supports:

Ethereum

BSC

Avalanche

Polygon

Fantom

Optimism

Arbitrum ### Wallets

[Metamask](https://metamask.io/download/)

[WalletConnect](https://walletconnect.com/)

[Coinbase Wallet](https://www.coinbase.com/wallet/articles/getting-started-extension)

### Casual swaps If you happen to need to sell your tokens or, for example, convert them to the required currency for an NFT purchase, YAD is a good option for this case too. YAD will figure out the best way for swapping to reduce any additional steps and/or costs for you. ### Buying or selling a rare token As long as the token you want to buy belongs to a blockchain network that we support, we support that token. Just paste the token address into the select token menu to find your token.

# Getting started Embarking on your journey into the decentralized finance (DeFi) ecosystem requires setting up a few foundational components. While the world of DeFi offers unparalleled financial freedom and opportunities, it also necessitates a certain level of understanding and preparation to navigate it effectively. Once set up, you'll need to fund it, connecting you to a vast network of trading possibilities. The following guides are tailored to assist you at every step. From wallet creation and funding to connecting your wallet and granting the necessary permissions, we've got you covered. And when you're ready to dive deep into trading, our guide on executing swaps will ensure a seamless experience. For those who truly immerse themselves in DeFi, understanding how to monitor transactions using a blockchain explorer becomes second nature—and we'll show you just how to do that. # Wallet creation To operate within the DeFi landscape, such as swapping tokens on YAD, you'll first need a secure digital wallet. This wallet not only holds your assets but also acts as your unique identifier in the decentralized world. ## Supported wallets YAD supports a bunch of popular wallets. Here's the list of wallets that we support:

[Metamask](https://metamask.io/download/)

[WalletConnect](https://walletconnect.com/)

[Coinbase Wallet](https://www.coinbase.com/wallet/articles/getting-started-extension)

[Binance Wallet](https://www.bnbchain.org/en/binance-wallet) ![](/files/43NJGtr1f8NHxULbohGX) [Exodus](https://www.exodus.com/) ![](/files/Vf9kr9Za8xvM7uGjHIK2) [Trezor](https://trezor.io/trezor-suite) ![](/files/XF9p6a8iMMhvSt0YIrW5) [Noone Wallet](https://noone.io/) ### What is a wallet? Think of your wallet as your home base in an unchartered territory: * **Safe storage**: Just like you keep your belongings in your home, your wallet is where you store your digital assets. * **Unique address**: Your home has an address to help others locate it; similarly, your wallet has a unique address to receive funds from your crypto neighbors or communicate in the wider DeFi world. * **Security is paramount**: Always lock your home's doors to keep intruders out. In the same way, ensure your wallet is secure and protected from potential threats. * **Don't lose your keys**: You need a key to enter your home. Likewise, you need a private key to access and manage your digital assets in your wallet. Guard it with your life! ### How do I create a wallet? If you're new to crypto, the number of wallet providers may seem intimidating. But don't worry, you can create a wallet for free using any of the above options for free, and can easily export/import it to another whenever you want (continuing the analogy, your home base has wheels and just needs somewhere to plug in). This is possible because Web3 wallets are noncustodial. Noncustodial means that the keys are in your hands, and no one else is responsible. You have full control over the access to your funds, just so long as you have the key. While all of the wallets supported by YAD Finance are safe and easy to use, they each offer various UI/UX configurations and distinct features. You can compare the options to choose which best suits your goals and desires, or click [here](https://metamask.io/download/) to install MetaMask — the most popular option. # How do I get crypto to start trading? Once you’ve installed MetaMask and created a wallet, it is necessary to top up your balance. You can buy crypto for fiat on various platforms. For example, you can purchase cryptocurrency within the MetaMask wallet via its payment providers or on any cryptocurrency exchange (e.g., Binance). # Wallet connection Once you have created your crypto wallet and topped up its balance, go to the [YAD app](https://app.yad.finance/1/exchange/eth/dai) and make your first swap! 1\) Сlick on the orange button "connect wallet" on the home page of the YAD app.

2\) Select your wallet from the list of supported wallets.

3\) After the previous step, you will be redirected to the wallet, where you will need to select an account to connect to YAD app.

4\) Since this is the first time you're connecting the wallet, you will be asked to grant permission for the YAD to establish a connection. Click on the "Connect" button to allow your MetaMask wallet to connect to YAD app.

# Token approval ## Why do I need to approve the use of my tokens before I can trade them? If you want to swap your token, keep in mind that YAD's smart contracts, like all others, need to get approval in order to be able to use your tokens to swap them. It is a necessary procedure for all the smart contracts that interact with tokens. The approval procedure requires you to specify the maximum number of tokens that you allow the smart contract to use. In the wallet form you can set some custom spending cap or use default spending limit, which sets the maximum possible value. It is also important to note that approval transaction has its own cost, since this is a separate transaction and gas is needed to complete it. {% hint style="info" %} If in the future you need to increase the allowed spending cap, then you will have to initiate another approval transaction. Therefore, for smart contracts you trust, we recommend using the default spending limit, which sets the maximum possible value. This way you can avoid extra transaction costs. {% endhint %} ## How do I approve a token? Actually, this procedure is quite easy. Here's a step-by-step guide on how to do this: 1\) First of all, click on the green button to allow to use required token.

2\) You will be redirected to your wallet. Here you can enter custom spending cap, but we recommend to use default value for YAD's smart contracts to avoid making extra transactions in the future.

3\) You will see the token amount that YAD's contract is allowed to use. Click "Next" to proceed.

4\) This is the final step. Click on the "Approve" button to execute an approval transaction.

{% hint style="info" %} If you want to learn more about token approvals and how you can manage the approvals you've already granted, you can read [this article](https://info.etherscan.com/tokenapprovals/) by [Etherscan](https://etherscan.io/). {% endhint %} # Making a swap Once you have approved the use of the token on YAD, it is time to make a swap! 1\) Let's take a look at the settings you can apply to your swap. To open settings, click on the settings icon:

2\) Here you can adjust [slippage tolerance](/knowledge-base/basics/what-is-slippage) and [gas price](/knowledge-base/basics/what-is-gas-price).

3\) Now you are all set, click the “Swap” button.

4\) On the next screen you will see your quote once again. Check that everything is correct and click "Confirm swap".

5\) You will be redirected to your wallet. Press "Confirm" to make a swap.

# How to check your transaction in blockchain Once a transaction is completed you can click “View on Explorer” to see your transaction status and other details.

If you closed that window, don't worry. You can always find your transaction in the blockchain scanner. {% hint style="info" %} You can find all your transactions on the blockchain scan pages: * Etherium - * BSC - * Avalanche - * Polygon - * Fantom - * Optimism - * Arbutrum - {% endhint %} ### To find your transaction, follow these steps: In this example, we will look for a transaction in the Ethereum network and [Etherscan](https://etherscan.io/). For other networks and their scanners, the principle is the same. 1\) Go to the scanner page of the network where the transaction has been made and enter your wallet address in the search box.

2\) After you paste the wallet address, you will see all transactions your wallet was involved in.\ Click on the one you were looking for.

3\) Check the "Status" field. * If the transaction is still being processed, you will see a "pending" status. * If the transaction is successful, you will see a "success" status. * If the transaction was reverted, you will see the "reverted" status.

# Swap modes At YAD Finance, we understand that flexibility and efficiency are paramount in the rapidly-evolving DeFi landscape. With that in mind, we've tailored our platform to offer two distinct swap modes, each designed to meet the unique needs and preferences of our users: * **One-Track Swaps:** This mode streamlines the trading experience. Dive into our expansive catalog of decentralized exchanges (DEXs) and let our system identify the optimal path for your transaction. Whether you're trading a popular token or something more niche, One-Track Swaps ensure you receive the best possible rate, all while enjoying a simplified and user-friendly interface. * **Chain-Hopping Swaps:** Explore the power of cross-chain transactions. Chain-Hopping allows you to seamlessly jump between different blockchain networks, converting your tokens in the process. Using advanced cross-chain technology, this mode ensures a secure and trustless asset transfer, bridging the gap between Ethereum and various L2 networks with remarkable ease. Explore further into our GitBook to get a deeper understanding of each swap mode and how YAD Finance is revolutionizing the DeFi experience.
# One-Track Swaps ### What is a One-Track Swap? One-track swaps represent a revolutionary method of exchanging tokens, tailored for swift and effortless trading. It's a feature of the YAD platform that focuses on optimal-route single-chain transactions to enhance the efficiency of the swapping process. ### How a One-Track Swap Works To truly grasp the mechanics behind one-track swaps, it's beneficial to explore our detailed [architecture section](/architecture). This will provide an in-depth view of how our system has been architected to execute one-track transactions. ### Benefits * **Market Diversity:** Upon initiating a one-track swap, the system dives deep into its extensive catalog of decentralized exchanges (DEXs). By analyzing various exchange routes, it identifies the most optimal path for the transaction, ensuring the user gets the best possible rate. * **Smart Routing:** YAD Finance's advanced algorithms can dynamically split transactions into multiple paths. This ensures users always get the best swap rates by capitalizing on different liquidity sources and minimizing slippage. * **Import Any Token:** One of the standout features of one-track swaps is the ability to handle any token. Users aren't restricted to a predefined list; instead, they can easily import and trade almost any token they desire. * **Efficiency:** One-track swaps minimize the steps and complexity typically associated with decentralized token exchanges. * **Cost-Effective:** By pinpointing the best exchange route, users often benefit from competitive rates, leading to potential savings. * **Flexibility:** The ability to import and trade any token means users aren't constrained by limited options, offering a broad trading horizon. * **Simplified User Experience:** With fewer steps and a streamlined process, even novice users can navigate the swap process with ease. ### Future Plans We're never content resting on our laurels. The roadmap for one-track swaps includes: * **Streamlined Operations:** Soon, users will be able to both swap and send tokens in one consolidated transaction, further simplifying the process and saving valuable time. * **Integration with More DEXs:** To offer even more comprehensive market diversity, plans are underway to integrate additional decentralized exchanges into the system. # Chain-Hopping Swaps ### What is a Chain-Hopping Swap? A chain-hopping swap is a mode that allows users to seamlessly transition from one blockchain network to another, swapping their tokens in the process. This innovative approach enables greater fluidity and flexibility for users to operate across various blockchain ecosystems without the need for multiple steps or complex procedures. ### How Cross-Chain Hopping Works YAD's cross-chain technology employs a combination of one-track swaps and native bridges. The cornerstone of this process is the native bridge, which forges a connection between Ethereum and L2 blockchains. Smart contracts ensure a secure and trustless asset transfer between these networks. Notably, these smart contracts are operational on both Ethereum and the L2 platform. Here's a breakdown of the process: 1. **Initiation of Swap:** The YAD app starts a swap process on Ethereum, converting your selected token into one that's compatible with the bridge. 2. **Asset Deposit:** Your converted assets are then securely deposited into the bridge smart contract on Ethereum. 3. **Token Minting on L2:** After this deposit, the bridge smart contract mints an equivalent token on the L2 network. This token stands as a representation of the assets you initially deposited on Ethereum. On average, the whole procedure, from initiation to completion, takes about 30 minutes. ### Benefits of Native Bridges * **Cost-Efficiency:** Native bridges are notably cost-effective when considering gas expenses. There are no added fees with native bridges, making swaps significantly affordable. * **Liquidity Flexibility:** With native bridges, there aren't restrictions concerning the liquidity amount you desire to bridge. * **Trustworthiness:** Native bridges exude reliability. They have been developed by L2 blockchain network proprietors who continually oversee and maintain them. This maintenance is mutually beneficial, as it's advantageous for these proprietors when users transition their liquidity from Ethereum to their respective networks. ### Integrated Native Bridges Currently, YAD has integrated three native bridges. You can delve deeper into each of them by following the links below:
| Network | Link | | -------- | ------------------------------------------------------------------------------------------ | | Polygon | | | Arbitrum | | | Optimism | | ### Future Plans Looking ahead, YAD aims to: * Initiate swaps within Layer 2 networks, for instance, moving from Arbitrum to Optimism. * Integrate bridges for additional networks such as BSC, Avalanche, and others. * Enable swaps from L2 back to Ethereum. # Diamond Mode ### What is Diamond Mode? Diamond Mode is a specialized swap feature on YetAnotherDeFi that guarantees the utmost security and fairness. The name “Diamond Mode” is derived from two defining characteristics: * **MEV-Protection**: The Diamond Mode ensures that your transactions remain safeguarded against Miner Extractable Value (MEV) attacks. In the crypto world, assets are treasures, and this mode offers diamond-like protection to these treasures. * **Exclusive Token Selection**: Diamond Mode only supports the most esteemed and trusted tokens for swaps, maintaining the exclusivity and value akin to diamonds. ### Benefits of Diamond Mode * **MEV Protection**: Ensures that every transaction is executed fairly without external manipulations. * **Trusted Liquidity**: Diamond Mode might provide more favorable quotes than many mainstream decentralized exchanges. * **No Slippage**: The price you see is the price you get; there's no fluctuation once quoted. * **Reduced Gas Fees**: Experience significant savings on transaction costs. ### How Does Diamond Mode Achieve This? At its core, Diamond Mode is powered by the RFQ (Request For Quote) mechanism. But what exactly is RFQ? It's a private negotiation between the user and a Market Maker. Here's a step-by-step breakdown: 1. **Quote Request**: You input the price for the token you wish to sell, prompting YetAnotherDeFi to request a quote from a Market Maker. 2. **Quote Confirmation**: If the offered price aligns with your expectations and you confirm the swap, YAD secures a 60-second trade order from the Market Maker. 3. **Signature Authentication**: The trader then signs this trade offer off-chain using the eip-712 signature. This procedure ensures high-level security by hashing and signing structured data, which includes fields like calldata, timestamp, and more. A unique hash is produced from these parameters, which is subsequently signed by the Market Maker's private key. This process ensures that any malicious interference will alter the hash and the signature, causing the transaction to fail. 4. **Transaction Completion**: Once YetAnotherDeFi obtains the signed calldata from the Market Maker, you'll authenticate the transaction in your wallet, followed by YAD initiating it on the blockchain. Voila! The swap is successfully completed. This RFQ mechanism, essentially a secured private deal, ensures the swap rate remains constant, resulting in zero slippage. Moreover, the inherent security features of this mechanism make it virtually impossible for MEV bots to disrupt your transaction, ensuring unparalleled protection. # Architecture High-level overview of the system architecture of YAD Finance YAD's architecture is centered around smart contracts, which serve to aggregate liquidity and execute transactions. Our design maximizes security and trust by using flash wallets, and a proxy contract is used as the entry point into the system, which then delegate-calls into features and transformers. 1. Proxy\ The central point of system interaction, handling all entry points. It operates by delegating specific functions to Features, managing the flow and exchange of assets. Each function is handled by a unique implementation contract or 'feature'. The Proxy's main job is to maintain a map of features and their corresponding contracts, rerouting calls to these through its fallback system.
2. Features\ These are the essential building blocks of the YAD smart contracts, trusted with user allowances. They are executed in the Proxy context via a delegate-call.
3. Flash Wallets\ Acting as secure escrow accounts, Flash Wallets hold funds for Transformers to work with. Features transfer tokens to these wallets, which in turn delegate calls to Transformers. This secure system ensures Transformers only have access to funds in the Flash Wallet, not user allowances.\ \ This type of interaction (with the flash wallet between internal smart-contract and trustless transformers) helps to increase security while internal smart contracts interact with transformers.
4. Transformers\ These contracts extend the core YAD smart contracts. Operating as trustless extensions, Transformers are approved by the Transformer Deployer. Each Transformer is tied to a specific nonce from the Transformer Deployer. Transformers execute their tasks in the context of the Flash Wallet via delegate-call, improving security during interactions.

Our implementation builds upon the proven and audited architecture of the 0x protocol. We opted to retain the transformer components within this structure due to their inherent modularity, offering flexibility in extending the core smart contracts. Importantly, transformers are invoked from the flash wallet, a design choice that reinforces the security of the system by compartmentalizing operations and maintaining strict access controls. **DEX Scraping and Swap Routing** YAD's frontend sends API requests to the backend roughly every 10 seconds, and when a user enters the "amount in" into the swap form or changes some parameters in the swap settings, the frontend asks the backend for the best price and route. Five route options are considered, including the 0x router, the 1inch router, the Odos router, and our own router and RFQ. Our router splits the "amount in" into 5% partitions and then calculates the best route for every partition. The final route takes into account the "amount out" and the gas used for the transaction. # Smart contracts How to interact with YAD’s smart contracts Our smart contracts are designed with a strong emphasis on interoperability, enabling seamless integration into diverse solutions. Accessible via our API, these contracts have been widely adopted by numerous parties to power their unique solutions and business operations, underlining the flexibility and utility of our design.
Our smart contracts offer two distinct usage methods: 1. You can directly utilize our API to acquire calldata and transmit it to our proxy address. 2. Alternatively, developers can construct their own custom smart contract on top of our existing smart contracts. By invoking our API, you can interact with our proxy smart contract and carry out the transaction using the call data you received from our API. This documentation is an evolving resource and will be updated as YAD's system continues to grow and improve. # Proxy addresses | Blockchain network | Name | Address | | --------------------------- | ------------- | ------------------------------------------ | | Ethereum (chainID = 1) | exchangeProxy | 0x1AAAd07998466cD3Eb8140827DDdb37570BE1e63 | | BSC (chainID = 56) | exchangeProxy | 0x6018B292fDDeAA83BB5d7B85415270B4Fc6d0C12 | | Avalanche (chainID = 43114) | exchangeProxy | 0x1AAAd07998466cD3Eb8140827DDdb37570BE1e63 | | Polygon (chainID = 137) | exchangeProxy | 0x8e4005c5a2F85408A95adF7831F9959edA7d87d1 | | Fantom (chainID = 250) | exchangeProxy | 0x1AAAd07998466cD3Eb8140827DDdb37570BE1e63 | | Optimism (chainID = 10) | exchangeProxy | 0x1AAAd07998466cD3Eb8140827DDdb37570BE1e63 | | Arbitrum (chainID = 42161) | exchangeProxy | 0x1AAAd07998466cD3Eb8140827DDdb37570BE1e63 | # Request for Quote (RFQ) The RFQ mode is a special feature of our system that allows users to make swaps through Market Makers instead of DEXs. This method ensures protection against Miner Extractable Value (MEV) and promises a secure trading environment. Furthermore, RFQ trades have 0% slippage, meaning the price at the time of the quote is the price you pay, effectively eliminating price uncertainty during the execution of your trade. Now RFQ is used as a route for swaps along with other routes. In the near future, we will be releasing a new RFQ Mode where all swaps will be sent through RFQ.
# One-Track Swaps API At YAD, we firmly believe in open-source development as the cornerstone for building a decentralized future. This guiding principle drives us to deliver products that empower and engage developers and users alike. A testament to this commitment is our One-Track Swaps API. ### **Overview** Our One-Track Swaps API is your gateway to unparalleled DeFi possibilities. With connectivity to over 75 liquidity sources, this API is built to be both robust and versatile. Whether you're aiming to elevate user functionalities or crafting your own decentralized exchange, you'll find all the tools at your disposal. Our goal? To ensure every token swap yields the optimal price, every time. ### **Hypothetical Use Cases** * **Web3 Wallet Integration**: Web3 wallet providers can seamlessly weave our API into their fabric, enabling swift and easy token swaps for their users. * **Gaming Integrations**: Elevate in-game purchases by offering swap functionalities. Developers can utilize our API, allowing users to conveniently swap their tokens for the game-specific tokens. * **Decentralized Exchange Creation:** Developers aspiring to create their own DEX can leverage our API to ensure a smooth and efficient exchange process, backed by a vast network of liquidity sources. * **Integration into Existing DEX:** For those already operating a decentralized exchange, integrating our liquidity sources can significantly expand exchange opportunities, ensuring improved quotes and a more competitive edge in the market. ### **Benefits of YAD One-track Swaps API** * **Market-leading Quotes**: With our proprietary algorithms, we unearth intelligent and unconventional routes, ensuring users get the most competitive quotes for their swaps. * **Low Transaction Costs**: Thanks to our gas-optimized smart contracts combined with pinpoint accurate real-time gas price calculations, unnecessary expenses become a thing of the past. * **Trust and Security**: The onus of initiating, signing, and sending the transaction remains with the user, reinforcing trust. We value privacy, ensuring no access to users' private keys or funds. Additionally, our smart contracts have undergone rigorous audits to bolster security. * **Dedicated Support**: Questions? Concerns? Feedback? Our highly-skilled support team is available round-the-clock, ensuring you're never left in the dark. Feel free to reach out to us at ! # Getting started 1. Read this documentation. 2. Try out YAD API using [Swagger](https://api.yetanotherdefi.com/swagger/index.html) or request examples we provided in this documentation. 3. For requests use API url: `https://api.yad.finance`. 4. If you have any questions about partnership with us, feel free to drop us a message at: ### API key management 1. Kindly note that without an API access key, the number of requests per second is limited, it is suitable for testing and development, but not for production capacity. 2. To obtain the key, please get in touch with . 3. The given key must be added to the header of each request, parameter {"X-API-Key": "\"} # Use cases 1. API — provides a list of supported blockchains upon request GET `v1/platforms`. 2. GUI — the user selects a network the exchange is made within. For example, Ethereum, ChainID=1. 3. API — provides a list of blockchain tokens upon request POST `v2/tokens/list`. 4. API (optional) – provides calculated gas price values in GWEI (nAVAX for Avalanche) for fast, medium, low transaction time GET `v1/{chainID}/gasprices` (in the example GET `v1/1/gasprices`). 5. GUI — the user selects the exchange tokens and the sale amount. For example, 1000 USDT to WBTC. 6. GUI — the user sets the slippage tolerance value as a percentage. The recommended value is 1%. 7. GUI (optional) — the user selects the gas price value from #4. 8. API — endpoint GET `v1/{chainID}/price` (GET `v1/1/price`) provides the number of tokens that the user will receive for the purchase (0.05 WBTC). 9. GUI — the user connects the wallet. 10. API — endpoint GET `v1/{chainID}/transaction/allowance` (GET `v1/1/transaction/allowance`) returns the amount of tokens that the exchange smart contract has access to (not required for native coins). 11. GUI — if the value of the sale is greater than the value from #10, the user is prompted to provide access for the tokens exchange (otherwise the exchange transaction will not be processed). 12. API — endpoint GET `v1/{chainID}/transaction/approve` returns the input parameters (calldata) for a transaction to provide access to tokens, and the address of the contract where the transaction should be sent to. 13. GUI — generates an unsigned transaction based on the data from #12 and sends it to the user's connected wallet. 14. WALLET — the user confirms the operation in the wallet, and the wallet then signs the transaction and sends it to the blockchain. 15. GUI — after successful confirmation of the transaction from #14, the user is offered a button to exchange the selected tokens. 16. API — by endpoint GET `v1/{chainID}/quote` (GET `v1/1/quote`) provides the number of the tokens purchased (0.05 WBTC), transaction input parameters. 17. GUI — generates an unsigned transaction based on the data from #16 and sends it to the user's connected wallet. 18. WALLET — the user confirms the operation in the wallet, and the wallet then signs the transaction and sends it to the blockchain. # Endpoint list ## Get plaftorms `GET` `v1/platforms` Provides a list of supported blockchain networks. **Request sample:**\ `https://api.yad.finance/v1/platforms` {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "platforms": [ { "chainId": 1, "name": "Ethereum", "shortname": "ETH" }, { "chainId": 10, "name": "Optimistic Ethereum", "shortname": "Optimism" }, { "chainId": 56, "name": "BNB Smart Chain", "shortname": "BSC" } ] } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Name | Data Type | Description | | ------------- | --------- | ----------------------------------------- | | **platforms** | `array` | An array of supported networks. | | **chainId** | `int` | The blockchain network ID. | | **shortname** | `str` | The short name of the blockchain network. | | **name** | `str` | The full name of the blockchain network. | ## Get gas prices `GET` `v1/{chainID}/gasprices` Provides calculated gas price values in GWEI (nAVAX for Avalanche). **Request sample:**\ `https://api.yad.finance/v1/1/gasprices` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ------------------------------------------------------- | | chainId\* | Integer | The blockchain ID for which the gas price is requested. | {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "baseFee": "13.757", "low": "14.757", "lowInfo": { "price": "14.757", "maxPriorityFeePerGas": "0.5", "maxFeePerGas": "14.257" }, "medium": "16.757", "mediumInfo": { "price": "16.757", "maxPriorityFeePerGas": "0.55", "maxFeePerGas": "15.683" }, "high": "18.757", "highInfo": { "price": "18.757", "maxPriorityFeePerGas": "0.65", "maxFeePerGas": "18.535" } } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% tab title="400: Bad Request Bad Request" %} {% endtab %} {% tab title="500: Internal Server Error Internal Server Error" %} {% endtab %} {% endtabs %}

Name	Data Type	Description
baseFee	`str`	Base fee for the next block in blockchain.
low	`str`	The gas price at which the transaction is most likely to be accepted not earlier than after block 5. There is a risk of a long transaction confirmation.
medium	`str`	The gas price at which the transaction is most likely to be accepted in the next 2-3 blocks.
high	`str`	The gas price at which the transaction is most likely to be accepted in the next block.
lowInfo (mediumInfo / highInfo)	`map`	Detailed gas price info for EIP-1559.
price	`str`	Gas price (for legacy transactions, not EIP-1559).
maxPriorityFeePerGas	`str`	Max Priority Fee Per Gas (tips in EIP-1559).
maxFeePerGas	`str`	Max Fee Per Gas (for EIP-1559).

## Get on-chain price for pair `GET` `v1/{chainID}/price` Returns the best route and exchange offer for pair, no calldata for transaction. Works faster than `/quote`.\ \ **Request sample:**\ `https://api.yetanotherdefi.com/v1/1/price?fromTokenAddress=0xdac17f958d2ee523a2206206994597c13d831ec7&toTokenAddress=0x6b175474e89094c44da98b954eedeac495271d0f&amount=1500000000&slippage=1&gasPrice=16000000000&feeRecipient=0xdac17f958d2ee523a2206206994597c13d831ec7&buyTokenPercentageFee=1&sellTokenPercentageFee=1&rfqOnly=false&withGas=false` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | --------------------------------------------------- | | chainID\* | Integer | Blockchain ID. (Supported networks - /v1/platforms) | #### Query Parameters | Name | Type | Description | | -------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fromTokenAddress\* | String | Smart contract address of the sale token. | | toTokenAddress\* | String | Smart contract address of the purchase token. | | amount\* | Integer | The amount of sale tokens in decimals of the token (can be taken from the method `/tokens`). | | slippage\* | Number |

The amount of slippage allowed during the actual execution of the transaction (10 = 1% slippage). If the price changes by more than this percentage, the transaction will revert. Min = 1 (0.1%), max = 500 (50%).

Default value : 1

| | gasPrice | String | Gas price value for making a transaction in WEI (nAVAX for Avalanche) (1 GWEI = 1000000000 WEI), default value is the value high from `/gasprices`. | | feeRecipient | String | Wallet address for receiving fees. The commission is paid from the purchase token. | | buyTokenPercentageFee | Integer | Percentage of commission from the amount of purchase tokens, is taken in favor of feeRecipient. (10 = 1%, maximum value is 500). | | sellTokenPercentageFee | Integer | Percentage of commission from the amount of sale tokens, is taken in favor of feeRecipient. (10 = 1%, maximum value is 500). | | rfqOnly | Boolean |

If TRUE: use only RFQ providers for routing.

Default value : false

If TRUE: choose a route based on gas.

Default value : false

| {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "amount_out_total": "1498367401285001674752", "estimate_gas_total": "595785", "token_in": "0xdac17f958d2ee523a2206206994597c13d831ec7", "token_out": "0x6b175474e89094c44da98b954eedeac495271d0f", "gas_price": "16000000000", "fee_recipient_amount": "1497002", "routes": [ { "type": "dex", "protocol_name": "eth_odos", "percent": 100 } ] } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% tab title="204: No Content No Content" %} {% endtab %} {% endtabs %}

Name	Data type	Description
amount_out_total	`str`	The amount of purchase tokens in decimals of the token.
estimate_gas_total	`str`	The estimated amount of gas that will be used during the transaction.
token_in	`str`	Smart contract address of the sale token.
token_out	`str`	Smart contract address of the purchase token.
gas_price	`str`	Gas price value for a transaction in WEI (nAVAX for Avalanche).
fee_recipient_amount	`str`	The amount of purchase tokens in decimals of the token, which will be taken in favor of feeRecipient. The value will be 0 if feeRecipient and buyTokenPercentageFee fields are not specified.
routes	`array`	An array of DEXs the transaction will be carried out through.
type	`str`	Liquidity source type.
protocol_name	`str`	DEX name the transaction will be carried out through.
percent	`int`	The percent of amount will be swapped on the current DEX.

## Transaction allowance `GET` `v1/{chainID}/transaction/allowance` Checks how many of the user's tokens the exchange smart contract has access to. **Request sample:**\ `https://api.yad.finance/v1/1/transaction/allowance?tokenAddress=0xdAC17F958D2ee523a2206206994597C13D831ec7&walletAddress=0x58f58219e2d2598588c1b457bb6da65c34d99310` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ---------------------------------------------------------------------------------------- | | chainID\* | Integer | The ID of the blockchain the token is located on (supported networks - `/v1/platforms`). | #### Query Parameters | Name | Type | Description | | ----------------------------------------------- | ------ | ---------------------------------------------------------------------- | | tokenAddress\* | String | Smart contract address of the token for which access is being checked. | | walletAddress\* | String | Wallet of the user for which access is being checked. | {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ``` { "remaining": "11579208923731620000" } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Name | Data Type | Description | | ------------- | --------- | ------------------------------------------------------------------------------- | | **remaining** | `str` | The number of tokens in decimals of the token the smart contract has access to. | ## Transaction approve `GET` `v1/{chainID}/transaction/approve` Generates transaction input parameters to provide access to the user's tokens for the exchange smart contract. **Request sample:**\ `https://api.yad.finance/v1/1/transaction/approve?tokenAddress=0xdAC17F958D2ee523a2206206994597C13D831ec7&amount=100000000000&gasPrice=100000000000` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ------------------------------------------------------------------------------------ | | chainID\* | Integer | ID of the blockchain the token is located on (supported networks - `/v1/platforms`). | #### Query Parameters | Name | Type | Description | | ---------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------- | | tokenAddress\* | String | Address of the smart contract of the token for which the access request is generated. | | takerAddress | String | Address of user’s wallet which will provide approve. When provided the gas will be estimated exactly. | | amount | integer | The amount of user tokens to which access is granted. By default - infinite number. | | gasPrice | Integer | Cost of gas for an approve transaction. By default: medium | | contractAddress | String | Contract that we want to give an approval. If not passed, then the default for chain is used. | {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ``` { "calldata": "0x095ea7b30000000000000000000000001aaad07998466cd3eb8140827dddb37570be1e63000000000000000000000000000000000000000000000000000000174876e800", "gas_price": "100000000000", "to": "0xdac17f958d2ee523a2206206994597c13d831ec7", "estimate_gas": "48561" } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %}

Name	Data Type	Description
calldata	`str`	One of the input parameters for processing a transaction providing access to tokens.
gas_price	`str`	Gas price value for a transaction in WEI.
to	`str`	Address of the smart contract the transaction should be sent to.
estimate_gas	`str`	The estimated amount of gas that will be used during the transaction.

## Get on-chain quote for pair `GET` `v1/{chainID}/quote` Returns the best exchange offer and input parameters for the transaction. **Request sample:**\ `https://api.yetanotherdefi.com/v1/1/quote?fromTokenAddress=0xdac17f958d2ee523a2206206994597c13d831ec7&toTokenAddress=0x6b175474e89094c44da98b954eedeac495271d0f&amount=1500000000&slippage=1&gasPrice=16000000000&feeRecipient=0xdac17f958d2ee523a2206206994597c13d831ec7&buyTokenPercentageFee=1&sellTokenPercentageFee=1&skipValidation=true&withGas=false` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | --------------------------------------------------------------------------------------- | | chainID\* | Integer | ID of the blockchain tokens must be exchanged on (supported networks - `v1/platforms`). | #### Query Parameters | Name | Type | Description | | -------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | fromTokenAddress\* | String | Smart contract address of the sale token. | | toTokenAddress\* | String | Smart contract address of the purchase token. | | takerAddress | String | The address which will fill the quote. When provided the gas will be estimated and returned. | | amount\* | Integer | The amount of sale tokens in decimals of the token (can be taken from the method `/tokens`). | | slippage\* | Integer | The amount of slippage allowed during the actual execution of the transaction (10 = 1% slippage). If the price changes by more than this percentage, the transaction will revert. Min = 1 (0.1%), max = 500 (50%). | | gasPrice | String | Gas price value for making a transaction in WEI (nAVAX for Avalanche) (1 GWEI = 1000000000 WEI), default value is the value high from `/gasprices`. | | feeRecipient | String | Wallet address for receiving fees. The commission is paid from the purchase token. | | buyTokenPercentageFee | Integer | Percentage of commission from the amount of purchase tokens, is taken in favor of feeRecipient. (10 = 1%, maximum value is 500). | | sellTokenPercentageFee | Integer | Percentage of commission from the amount of sell tokens, is taken in favor of feeRecipient. (10 = 1%, maximum value is 500). | | recipientAddress | String |

Wallet address for receiving purchase tokens.
By default: sender address.

| | skipValidation | Boolean |

If TRUE: skip calldata validation

Default value : true

If TRUE: choose a quote based on gas.

Default value : false

| {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "amount_out_total": "1498328896581420449792", "estimate_gas_total": "645770", "token_in": "0xdac17f958d2ee523a2206206994597c13d831ec7", "token_out": "0x6b175474e89094c44da98b954eedeac495271d0f", "gas_price": "16000000000", "fee_recipient_amount": "0", "routes": [ { "type": "dex", "protocol_name": "eth_odos", "percent": 100 } ], "calldata": "0x1342555a00000000000000000000000076f4eed9fe41262669d0250b2a97db79712ad85500000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000dac17f958d2ee523a2206206994597c13d831ec700000000000000000000000000000000000000000000000000000000595157560000000000000000000000006b175474e89094c44da98b954eedeac495271d0f00000000000000000000000000000000000000000000005124b26ec2d91fba5e000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002a4f17a454600000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000001e42741ef6a26c2eb653000000000000000000000000000000000000000000001e3ab50761655600000000000000000000000000000000000bdc51918c9407d2a7a0f34b68f16c26ea13ac2c9000000000000000000000000000000000000000000000000000000000000022000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000020000000000000000000000000dac17f958d2ee523a2206206994597c13d831ec70000000000000000000000000000000000000000000000000000000059515756000000000000000000000000bdc51918c9407d2a7a0f34b68f16c26ea13ac2c90000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000006b175474e89094c44da98b954eedeac495271d0f0000000000000000000000000000000000000000000000000000000005f5eedb000000000000000000000000ca188796c709f3e052006a7e1e80b309ddd260ad0000000000000000000000000000000000000000000000000000000000000048010203000d0101010200ff00000000000000000000000000000000000000000048da0965ab2d2cbf1c17c09cfb5cbe67ad5b1406dac17f958d2ee523a2206206994597c13d831ec700000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000a97e0564F0AAC50000", "to": "0x1AAAd07998466cD3Eb8140827DDdb37570BE1e63", "expiry": 1693494007 } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% tab title="204: No Content No Content" %} {% endtab %} {% endtabs %}

Name	Data type	Description
amount_out_total	`str`	The amount of purchase tokens in decimals of the token.
estimate_gas_total	`str`	The estimated amount of gas that will be used during the transaction.
token_in	`str`	Smart contract address of the sale token.
token_out	`str`	Smart contract address of the purchase token.
gas_price	`str`	Gas price value for a transaction in WEI (nAVAX for Avalanche).
fee_recipient_amount	`str`	The amount of purchase tokens in decimals of the token, which will be taken in favor of feeRecipient. The value will be 0 if feeRecipient and buyTokenPercentageFee fields are not specified.
routes	`array`	An array of DEXs the transaction will be carried out through.
type	`str`	Liquidity source type.
protocol_name	`str`	DEX name the transaction will be carried out through.
percent	`int`	The percent of amount will be swapped on the current DEX.
calldata	`str`	One of the input parameters for processing a transaction for tokens exchange.
to	`str`	Smart contract address where input parameters should be sent to.
expiry	`int`	Quote expiration time (in unix epoch time format). Applicable for RFQ providers only.

## List tokens `POST` `v2/tokens/list` Get a list of tokens with filters and pagination. **Request sample** cURL: `curl -X 'POST' \` \ `'https://api.yetanotherdefi.com/v2/tokens/list' \` \ `-H 'accept: application/json' \` \ `-H 'Content-Type: application/json' \` \ `-d '{ "filter": { "symbols": [ "ETH" ] }, "paging": { "page": 1, "page_size": 100 } }'` #### Request Body | Name | Type | Description | | -------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | filter | object |

Filtering occurs with an 'AND' statement between fields and an 'OR' statement between array elements.

For example: chain\_ids\[1, 2], names\[asd] == all tokens where chain\_id is "1" or "2" and name equal "asd".

Searching by all text filters is case-insensitive.

FALSE = the token is rarely used in exchanges on DEXs

If null - get only active.

Page number.

This parameter can be useful when the total sample size of tokens that meet the criteria from the filter exceeds the page size.

Can't be less than 1.

| | page\_size | integer |

Response size. For example, "page\_size": 5 == get 5 tokens that meet the filtering conditions.

Max 100. If zero - unlitimited page size

| {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "tokens": [ { "chainId": 1, "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", "name": "Ethereum", "symbol": "ETH", "decimals": 18, "logoURI": "https://cl.yad.finance/static-files/1i/1/0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/48x48.png", "is_active": true, "priority": 1, "is_rfq_mode": false }, { "chainId": 10, "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", "name": "Ethereum", "symbol": "ETH", "decimals": 18, "logoURI": "https://cl.yad.finance/static-files/1i/10/0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/48x48.png", "is_active": true, "priority": 1, "is_rfq_mode": false } ] } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Name | Data type | Description | | ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **tokens** | `array` | An array of tokens. | | **chainId** | `int` | The blockchain network ID. | | **address** | `str` | The token smart contract address. | | **name** | `str` | Full name of the token. | | **symbol** | `str` | Abbreviated name of the token. | | **decimals** | `int` | The number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 \*\* 2). | | **logoURI** | `str` | A link to the token logo. | | **is\_active** | `boolean` | FALSE = the token is rarely used in exchanges on DEXs. | | **priority** | `int` | Recommended priority of a token to be shown to the user, based on the popularity of the token. | | **is\_rfq\_mode** | `boolean` | TRUE = the token is supported by RFQ providers. | # Cross-Chain Swaps API At YAD, we envision a boundless decentralized universe, interconnected seamlessly. Taking a massive leap in turning this vision into reality, we proudly introduce our Cross-Chain Swaps API. Built with precision and passion, this tool bridges diverse blockchain ecosystems effortlessly. ### **Overview** The YAD Cross-Chain Swaps API is a testament to our unwavering commitment to building an integrated DeFi universe. By connecting distinct blockchain territories, we aim to eradicate boundaries and create a singular, cohesive DeFi experience. Dive into a world where every swap, regardless of its origin chain, finds its optimal destination. ### **Hypothetical Use Cases** * **DApps Integration**: DApp developers can infuse cross-chain functionality, granting users the liberty to operate across various blockchain ecosystems without friction. * **Wallet Services Upgrade**: Wallet providers can integrate our API to support transactions and swaps between different chains, ensuring their users always have access to the best possible liquidity and rates. * **Cross-chain Liquidity Pools**: Boost liquidity by offering pools that tap into multiple chains, allowing users to leverage the best of all worlds. * **Blockchain Interoperability Projects**: Those building solutions to connect various blockchains can make use of our API to smoothen and enhance the cross-chain experience for their users. ### **Benefits of YAD Cross-Chain Swaps API** * **Seamless Swapping**: Transition between chains fluidly, with the assurance of securing optimal swap rates and minimal slippage. * **Uncompromised Speed**: Despite the intricacies of cross-chain operations, our API ensures swift and efficient transactions, always keeping pace with your needs. * **Reliable and Safe**: Trust remains paramount. Our Cross-Chain Swaps API ensures every swap is secure. Plus, our technology is backed by comprehensive audits, reinforcing our commitment to safety. * **Broadened Horizons**: Our vision extends beyond the current horizons of the DeFi ecosystem. We're actively charting a course towards enhanced functionalities, including initiating swaps within Layer 2 networks and seamlessly integrating bridges for burgeoning networks such as BSC, Avalanche, and more. Moreover, our future roadmap promises the capability to facilitate swaps from L2 networks back to Ethereum, ensuring our users have unparalleled access and flexibility across the blockchain spectrum. * **24/7 Support**: Our dedicated team is always ready, eager to assist, guide, and ensure your cross-chain endeavors are seamless. Drop us a line at ! # Getting started 1. Read this documentation. 2. Try out YAD API using [Swagger](https://api.yetanotherdefi.com/swagger/index.html) or request examples we provided in this documentation. 3. For requests use API url: `https://api.yad.finance`. 4. If you have any questions about partnership with us, feel free to drop a message at: ### API key management 1. Kindly note that without an API access key, the number of requests per second is limited, it is suitable for testing and development, but not for production capacity. 2. To obtain the key, please get in touch with . 3. The given key must be added to the header of each request, parameter {"X-API-Key": "\"} # Use cases 1. API — provides a list of supported blockchains as well as a list of tokens for a destination network upon request GET `v1/tokens/allForSwapAndBridge` 2. API — provides a list of tokens for a “departure” network upon request POST `v2/tokens/list`. 3. API (optional) — provides calculated gas price values in GWEI (nAVAX for Avalanche) for fast, medium, low transaction time GET `v1/{chainID}/gasprices` (in the example GET `v1/1/gasprices` - chainID=fromChainID) 4. GUI — the user selects the networks and tokens the exchange is made between. For example, for an Ethereum -> Polygon swap, the parameters will be: 1. fromChainID = 1; toChainID = 137 2. fromTokenAddress = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 (USDC) 3. toTokenAddress = 0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063 (DAI) 5. GUI — the user enters a sale amount. 6. GUI (optional) — the user selects the gas price value from #3. 7. GUI — the user sets the slippage tolerance value as a percentage. The recommended value is 1%. 8. API — endpoint GET `v1/price` provides the number of tokens that the user will receive for the purchase. 9. GUI — the user connects the wallet. 10. API — endpoint GET `v1/{chainID}/transaction/allowance` (GET `v1/1/transaction/allowance`) returns the amount of tokens that the exchange smart contract has access to (not required for native coins, chainID = fromChainID). 11. GUI — if the value of the sale is greater than the value from #10, the user is prompted to provide access for the tokens exchange (otherwise the exchange transaction will not be processed). 12. API — endpoint GET `v1/{chainID}/transaction/approve` returns the input parameters (calldata) for a transaction to provide access to tokens, and the address of the contract where the transaction should be sent to. 13. GUI — generates an unsigned transaction based on the data from #12 and sends it to the user's connected wallet. 14. WALLET — the user confirms the operation in the wallet, and the wallet then signs the transaction and sends it to the blockchain. 15. GUI — after successful confirmation of the transaction from #14, the user is offered a button to exchange the selected tokens. 16. API — by endpoint GET `v1/quote` provides the number of the tokens purchased, transaction input parameters. 17. GUI — generates an unsigned transaction based on the data from #16 and sends it to the user's connected wallet. 18. WALLET — the user confirms the operation in the wallet, and the wallet then signs the transaction and sends it to the blockchain. {% hint style="info" %} The endpoints `v1/price` and `v1/quote` can also be used for swaps within the same blockchain network. Just specify the same blockchain identifier for parameters fromChainID and toChainID. {% endhint %} # Endpoint list ## A list of tokens and blockchains for bridging `GET` `v1/tokens/allForSwapAndBridge` Provides a list of supported blockchains as well as a list of tokens for a destination network.\ \ **Request sample:**\ `https://api.yetanotherdefi.com/v1/tokens/allForSwapAndBridge` {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "1": { "10": [ { "chainId": 10, "address": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", "name": "Ether", "symbol": "ETH", "decimals": 18, "logoURI": "", "is_active": false, "is_rfq_mode": false }, { "chainId": 10, "address": "0x50c5725949a6f0c72e6c4a641f24049a917db0cb", "name": "Lyra Token", "symbol": "LYRA", "decimals": 18, "logoURI": "https://cl.yad.finance/static-files/1i/10/0x50c5725949a6f0c72e6c4a641f24049a917db0cb/48x48.png", "is_active": false, "is_rfq_mode": false } ] } } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %}

Name	Data Type	Description
{fromChainID}	`map (dictionary)`	ChainID of “departure” networks.
{toChainID}	`array`	An array of supported tokens for "destination" network.
chainId	`int`	The blockchain network ID.
address	`str`	The token smart contract address.
name	`str`	Full name of the token.
symbol	`str`	Abbreviated name of the token.
decimals	`int`	The number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5,05 (505 / 10 ** 2).
logoURI	`str`	A link to the token logo.
is_active	`boolean`	FALSE = the token is rarely used in exchanges on DEXs.
is_rfq_mode	`boolean`	TRUE = the token is supported by RFQ providers.

## Get gas prices `GET` `v1/{chainID}/gasprices` Provides calculated gas price values in GWEI (nAVAX for Avalanche). **Request sample:**\ `https://api.yad.finance/v1/1/gasprices` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ------------------------------------------------------- | | chainId\* | Integer | The blockchain ID for which the gas price is requested. | {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "baseFee": "13.757", "low": "14.757", "lowInfo": { "price": "14.757", "maxPriorityFeePerGas": "0.5", "maxFeePerGas": "14.257" }, "medium": "16.757", "mediumInfo": { "price": "16.757", "maxPriorityFeePerGas": "0.55", "maxFeePerGas": "15.683" }, "high": "18.757", "highInfo": { "price": "18.757", "maxPriorityFeePerGas": "0.65", "maxFeePerGas": "18.535" } } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% tab title="400: Bad Request Bad Request" %} {% endtab %} {% tab title="500: Internal Server Error Internal Server Error" %} {% endtab %} {% endtabs %}

Name	Data Type	Description
baseFee	`str`	Base fee for the next block in blockchain.
low	`str`	The gas price at which the transaction is most likely to be accepted not earlier than after block 5. There is a risk of a long transaction confirmation.
medium	`str`	The gas price at which the transaction is most likely to be accepted in the next 2-3 blocks.
high	`str`	The gas price at which the transaction is most likely to be accepted in the next block.
lowInfo (mediumInfo / highInfo)	`map`	Detailed gas price info for EIP-1559.
price	`str`	Gas price (for legacy transactions, not EIP-1559).
maxPriorityFeePerGas	`str`	Max Priority Fee Per Gas (tips in EIP-1559).
maxFeePerGas	`str`	Max Fee Per Gas (for EIP-1559).

## Get price for pair `GET` `v1/price` Returns the best route and exchange offer for pair, no calldata for transaction. Works faster than `/quote`.\ \ **Request sample:**\ `https://api.yetanotherdefi.com/v1/price?fromChainID=1&toChainID=137&fromTokenAddress=0xdac17f958d2ee523a2206206994597c13d831ec7&toTokenAddress=0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063&amount=150&slippage=10&feeRecipient=0x47ac0fb4f2d84898e4d9e7b4dab3c24507a6d503&sellTokenPercentageFee=10&rfqOnly=false`
#### Query Parameters | Name | Type | Description | | -------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fromTokenAddress\* | String | Smart contract address of the sale token. | | toTokenAddress\* | String | Smart contract address of the purchase token. | | amount\* | Integer | The amount of sale tokens in decimals of the token (can be taken from the method `/tokens`). | | slippage\* | Number |

If TRUE: use only RFQ providers for routing.

Default value : false

| | excludeAggregator | String | Exclude some aggregators from routing (add several parameters for multiple exclude). | | includeAggregator | String | Include some aggregators from routing (add several parameters for multiple include). This parameter cannot be combined with excludedAggregators. | | fromChainID\* | Integer | Source/sell blockchain ID | | toChainID\* | Intger | Destination/buy blockchain ID | | onchainExcludeAggregator | String | Exclude some aggregators from on-chain routing (add several parameters for multiple exclude). | | onchainIncludeAggregator | String | Include some aggregators from on-chain routing (add several parameters for multiple include). This parameter cannot be combined with onchainExcludeAggregators. | {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "amount_out_total": "150513308498454", "estimate_gas_total": "500000", "token_in": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "token_out": "0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063", "gas_price": "17877704887", "bridge_fee": "", "fees": null, "routes": [ { "type": "dex", "protocol_name": "native_polygon", "amount_in": "150", "amount_out": "150", "percent": 100 } ] } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% tab title="204: No Content No Content" %} {% endtab %} {% endtabs %}

Name	Data type	Description
amount_out_total	`str`	The amount of purchase tokens in decimals of the token.
estimate_gas_total	`str`	The estimated amount of gas that will be used during the transaction.
token_in	`str`	Smart contract address of the sale token.
token_out	`str`	Smart contract address of the purchase token.
gas_price	`str`	Gas price value for a transaction in WEI (nAVAX for Avalanche).
bridge_fee	`str`	Bridge protocol fee.
fees	`array`	Partner's fee.
amount	`str`	The amount of sell tokens in decimals of the token, which will be taken in favor of feeRecipient. The value will be 0 if feeRecipient and sellTokenPercentageFee fields are not specified.
recipient	`str`	Wallet address for receiving fees. The commission is paid from the purchase token.
token	`str`	Address of fee token.
routes	`array`	An array of DEXs the transaction will be carried out through.
type	`str`	Liquidity source type.
protocol_name	`str`	DEX name the transaction will be carried out through.
percent	`int`	The percent of amount will be swapped on the current DEX.

## Transaction allowance `GET` `v1/{chainID}/transaction/allowance` Checks how many of the user’s tokens the exchange smart contract has access to. **Request sample:**\ `https://api.yad.finance/v1/1/transaction/allowance?tokenAddress=0xdAC17F958D2ee523a2206206994597C13D831ec7&walletAddress=0x58f58219e2d2598588c1b457bb6da65c34d99310` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ---------------------------------------------------------------------------------------- | | chainID\* | Integer | The ID of the blockchain the token is located on (supported networks - `/v1/platforms`). | #### Query Parameters | Name | Type | Description | | ----------------------------------------------- | ------ | ---------------------------------------------------------------------- | | tokenAddress\* | String | Smart contract address of the token for which access is being checked. | | walletAddress\* | String | Wallet of the user for which access is being checked. | {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ``` { "remaining": "11579208923731620000" } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Name | Data Type | Description | | ------------- | --------- | ------------------------------------------------------------------------------- | | **remaining** | `str` | The number of tokens in decimals of the token the smart contract has access to. | ## Transaction approve `GET` `v1/{chainID}/transaction/approve` Generates transaction input parameters to provide access to the user's tokens for the exchange smart contract. **Request sample:**\ `https://api.yad.finance/v1/1/transaction/approve?tokenAddress=0xdAC17F958D2ee523a2206206994597C13D831ec7&amount=100000000000&gasPrice=100000000000` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ------------------------------------------------------------------------------------ | | chainID\* | Integer | ID of the blockchain the token is located on (supported networks - `/v1/platforms`). | #### Query Parameters | Name | Type | Description | | ---------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------- | | tokenAddress\* | String | Address of the smart contract of the token for which the access request is generated. | | takerAddress | String | Address of user’s wallet which will provide approve. When provided the gas will be estimated exactly. | | amount | integer | The amount of user tokens to which access is granted. By default - infinite number. | | gasPrice | Integer | Cost of gas for an approve transaction. By default: medium | | contractAddress | String | Contract that we want to give an approval. If not passed, then the default for chain is used. | {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ``` { "calldata": "0x095ea7b30000000000000000000000001aaad07998466cd3eb8140827dddb37570be1e63000000000000000000000000000000000000000000000000000000174876e800", "gas_price": "100000000000", "to": "0xdac17f958d2ee523a2206206994597c13d831ec7", "estimate_gas": "48561" } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %}

Name	Data Type	Description
calldata	`str`	One of the input parameters for processing a transaction providing access to tokens.
gas_price	`str`	Gas price value for a transaction in WEI.
to	`str`	Address of the smart contract the transaction should be sent to.
estimate_gas	`str`	The estimated amount of gas that will be used during the transaction.

## Get quote for pair `GET` `v1/quote` Returns the best exchange offer and input parameters for the transaction.\ \ **Request sample:**\ `https://api.yetanotherdefi.com/v1/quote?fromChainID=1&toChainID=137&fromTokenAddress=0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee&toTokenAddress=0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063&takerAddress=0x47ac0fb4f2d84898e4d9e7b4dab3c24507a6d503&amount=150&slippage=10&feeRecipient=0x47ac0fb4f2d84898e4d9e7b4dab3c24507a6d503&sellTokenPercentageFee=10&rfqOnly=false&skipValidation=true`
#### Query Parameters | Name | Type | Description | | -------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fromTokenAddress\* | String | Smart contract address of the sale token. | | toTokenAddress\* | String | Smart contract address of the purchase token. | | amount\* | Integer | The amount of sale tokens in decimals of the token (can be taken from the method `/tokens`). | | slippage\* | Number |

If TRUE: use only RFQ providers for routing.

Default value : false

If TRUE: skip calldata validation

Default value : true

| {% tabs %} {% tab title="200: OK OK" %} {% tabs %} {% tab title="Example" %} ```json { "amount_out_total": "244624", "estimate_gas_total": "348908", "token_in": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", "token_out": "0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063", "gas_price": "32853665207", "bridge_fee": "", "fees": null, "routes": [ { "type": "dex", "protocol_name": "native_polygon", "amount_in": "150", "amount_out": "244624", "percent": 100 } ], "calldata": "0xb6aa8d2d00000000000000000000000047ac0fb4f2d84898e4d9e7b4dab3c24507a6d503000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee0000000000000000000000006b175474e89094c44da98b954eedeac495271d0f0000000000000000000000000000000000000000000000000000000000000096000000000000000000000000000000000000000000000000000000000003b201000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000001600000000000000000000000000000000000000000000000000000000000000180000000000000000000000000000000000000000000000000000000000000008900000000000000000000000000000000000000000000000000000000000007c0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000604415565b0000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee0000000000000000000000006b175474e89094c44da98b954eedeac495271d0f0000000000000000000000000000000000000000000000000000000000000096000000000000000000000000000000000000000000000000000000000003b1ff00000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000420000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000040000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee00000000000000000000000000000000000000000000000000000000000000960000000000000000000000000000000000000000000000000000000000000007000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000002c000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc20000000000000000000000006b175474e89094c44da98b954eedeac495271d0f00000000000000000000000000000000000000000000000000000000000001400000000000000000000000000000000000000000000000000000000000000280000000000000000000000000000000000000000000000000000000000000028000000000000000000000000000000000000000000000000000000000000002400000000000000000000000000000000000000000000000000000000000000096000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002800000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000003556e69737761700000000000000000000000000000000000000000000000000000000000000000000000000000000096000000000000000000000000000000000000000000000000000000000003b20000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000020000000000000000000000000c0a47dfe034b400b47bdad5fecda2621de6c4d950000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000001000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000e11c8364F9E5EE0000", "to": "0x1AAAd07998466cD3Eb8140827DDdb37570BE1e63", "value": "150" } ``` {% endtab %} {% tab title="Schema" %} {% endtab %} {% endtabs %} {% endtab %} {% tab title="204: No Content No Content" %} {% endtab %} {% endtabs %}

Name	Data type	Description
amount_out_total	`str`	The amount of purchase tokens in decimals of the token.
estimate_gas_total	`str`	The estimated amount of gas that will be used during the transaction.
token_in	`str`	Smart contract address of the sale token.
token_out	`str`	Smart contract address of the purchase token.
gas_price	`str`	Gas price value for a transaction in WEI (nAVAX for Avalanche).
bridge_fee	`str`	Bridge protocol fee.
fees	`array`	Partner's fee.
amount	`str`	The amount of sell tokens in decimals of the token, which will be taken in favor of feeRecipient. The value will be 0 if feeRecipient and sellTokenPercentageFee fields are not specified.
recipient	`str`	Wallet address for receiving fees. The commission is paid from the purchase token.
token	`str`	Address of fee token.
routes	`array`	An array of DEXs the transaction will be carried out through.
type	`str`	Liquidity source type.
protocol_name	`str`	DEX name the transaction will be carried out through.
percent	`int`	The percent of amount will be swapped on the current DEX.
calldata	`str`	One of the input parameters for processing a transaction for tokens exchange.
to	`str`	Smart contract address where input parameters should be sent to.
value	`str`	ETH value that must be transferred along with the transaction in order for it to be successful.

Filtering occurs with an 'AND' statement between fields and an 'OR' statement between array elements.

For example: chain\_ids\[1, 2], names\[asd] == all tokens where chain\_id is "1" or "2" and name equal "asd".

Searching by all text filters is case-insensitive.

FALSE = the token is rarely used in exchanges on DEXs

If null - get only active.

Page number.

This parameter can be useful when the total sample size of tokens that meet the criteria from the filter exceeds the page size.

Can't be less than 1.

| | page\_size | integer |

Response size. For example, "page\_size": 5 == get 5 tokens that meet the filtering conditions.

Max 100. If zero - unlitimited page size


Parameters	Description	Default values	Possible values
chainId	The blockchain network ID.	1 (Ethereum)	1 - Ethereum 10 - Optimism 56 - BSC 137 - Polygon 250 - Fantom 43114 - Avalanche 42161 - Arbitrum
symbolFrom	Default sell token symbol or token contract address from selected chainId.	Native coin of selected chainID.	You can find more options here or insert your own token address.
symbolTo	Default buy token symbol or token contract address from selected chainId.	DAI	You can find more options here or insert your own token address.
theme	Dark or Light mode.	Derived from browser theme	“dark”, “light”
feeRecipient	Wallet address for receiving fees. The commission is paid from the purchase token.	null (no fees)	EVM address (in lowercase or uppercase)
feePercentage*	Percentage of commission from the amount of purchase tokens, taken in favor of feeRecipient. *When fees are enabled, the displayed purchase amount will already have the transaction fee deducted.	0 (no fees)	(10 = 1%, maximum value is 500)
isLockNetwork	If true, user cannot change selected network.	false	true, false
isLockFromToken	If true, user cannot change selected sell token.	false	true, false
isLockToToken	If true, user cannot change selected buy token.	false	true, false

## Integrating the YAD Widget To embed the YAD Widget on your website, follow the steps below: ### **Choose your widget type** **Vertical widget:** Suitable for widths between 280-416 px. ``` ``` **Horizontal widget:** Optimized for a width of 1180 px. ``` ``` **Flexible widget:** The widget will automatically adjust its orientation based on the width size. If the width is less than 1180, the widget will display vertically; otherwise, it will be horizontal. ``` ``` ### **Implement URL configuration within widget code** Replace the `src` attribute value in the `