# Squid Dev Documentation ## Squid Dev Documentation - [Overview](https://docs.squidrouter.com/getting-started/readme.md): The cheapest, fastest, most reliable cross-chain layer, routing value for 1,000+ integrators including MetaMask, Ripple, and MiniPay. - [Integrator Quickstart](https://docs.squidrouter.com/getting-started/integrator-quickstart.md): Create your first Squid cross-chain route request - [Add A Widget](https://docs.squidrouter.com/widget-integration/add-a-widget.md) - [Swap widget](https://docs.squidrouter.com/widget-integration/add-a-widget/widget.md) - [Getting Started](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/getting-started.md): Supported environments, chains, tokens and wallets - [Installing the Widget](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/installing-the-widget.md): Preparing to integrate the widget into your app - [React Installation](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/react-installation.md): Installing the React component - [NextJS Installation](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/nextjs-installation.md): Integrating the widget into a NextJS app - [Vite Installation](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/vite-installation.md) - [Iframe Installation](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/iframe-installation.md): Integrating the widget as an Iframe - [Customization Guide](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/customization-guide.md) - [Default User Settings](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/customization-guide/default-user-settings.md) - [Theme Customization](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/customization-guide/theme-customization.md) - [Configuring Content](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/customization-guide/configuring-content.md) - [Default Chains and Tokens](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/customization-guide/default-chains-and-tokens.md) - [Configuration Types](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/customization-guide/configuration-types.md) - [Collect Fees](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/customization-guide/collect-fees.md) - [Information for Integrators](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/information-for-integrators.md): Here you will find a brief onboarding guide to ensure the integration is as smooth as possible for your team and users - [Set default chains and tokens via URL](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/set-default-chains-and-tokens-via-url.md) - [Errors](https://docs.squidrouter.com/widget-integration/add-a-widget/widget/errors.md): Here is a list of errors that some users were facing that have a known fix - [Deposit widget](https://docs.squidrouter.com/widget-integration/add-a-widget/deposit-widget.md) - [Getting Started](https://docs.squidrouter.com/widget-integration/add-a-widget/deposit-widget/getting-started.md): Supported environments, chains, tokens and wallets - [Installing the Widget](https://docs.squidrouter.com/widget-integration/add-a-widget/deposit-widget/installing-the-widget.md): Preparing to integrate the Deposit Widget into your app - [React Installation](https://docs.squidrouter.com/widget-integration/add-a-widget/deposit-widget/react-installation.md): Installing the React component - [Next.js Installation](https://docs.squidrouter.com/widget-integration/add-a-widget/deposit-widget/nextjs-installation.md): Integrating the Deposit Widget into a Next.js app - [Vite Installation](https://docs.squidrouter.com/widget-integration/add-a-widget/deposit-widget/vite-installation.md): Integrating the Deposit Widget into a Vite app - [Configuration](https://docs.squidrouter.com/widget-integration/add-a-widget/deposit-widget/configuration.md): Full reference for the Deposit Widget's config prop - [Stake widget](https://docs.squidrouter.com/widget-integration/add-a-widget/stake-widget.md) - [Installing the Widget](https://docs.squidrouter.com/widget-integration/add-a-widget/stake-widget/installing-the-widget.md): Preparing to integrate the widget into your app - [Configuration](https://docs.squidrouter.com/widget-integration/add-a-widget/stake-widget/configuration.md): Staking widget configuration - [Importing The widget](https://docs.squidrouter.com/widget-integration/add-a-widget/stake-widget/importing-the-widget.md) - [API](https://docs.squidrouter.com/api-and-sdk-integration/api.md) - [Swap & Bridge Example](https://docs.squidrouter.com/api-and-sdk-integration/api/swap-and-bridge-example.md) - [Staking Example](https://docs.squidrouter.com/api-and-sdk-integration/api/staking-example.md) - [Cross-chain NFT Purchase Example](https://docs.squidrouter.com/api-and-sdk-integration/api/cross-chain-nft-purchase-example.md) - [Get Route Status](https://docs.squidrouter.com/api-and-sdk-integration/api/get-route-status.md) - [Authentication](https://docs.squidrouter.com/api-and-sdk-integration/api/authentication.md) - [Rate Limiting](https://docs.squidrouter.com/api-and-sdk-integration/api/rate-limiting.md) - [Error Codes](https://docs.squidrouter.com/api-and-sdk-integration/api/error-codes.md) - [SDK](https://docs.squidrouter.com/api-and-sdk-integration/sdk.md) - [Cross-chain Swap Example](https://docs.squidrouter.com/api-and-sdk-integration/sdk/cross-chain-swap-example.md) - [Staking Example](https://docs.squidrouter.com/api-and-sdk-integration/sdk/staking-example.md) - [Cross-chain NFT Purchase Example](https://docs.squidrouter.com/api-and-sdk-integration/sdk/cross-chain-nft-purchase-example.md) - [Get Route Status](https://docs.squidrouter.com/api-and-sdk-integration/sdk/get-route-status.md): This method aims to provide the status of the transaction - [Chains, Tokens & Prices](https://docs.squidrouter.com/api-and-sdk-integration/sdk/chains-tokens-balances.md) - [Key Concepts](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts.md) - [Squid Aggregator](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/squid-aggregator.md) - [Squid Intents](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/squid-aggregator/squid-intents.md) - [Cosmos](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/squid-aggregator/cosmos.md) - [CCTP](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/squid-aggregator/cctp.md) - [Chainflip](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/squid-aggregator/chainflip.md) - [Axelar](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/squid-aggregator/axelar.md) - [Layer Zero](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/squid-aggregator/layer-zero.md) - [Route Request Parameters](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/route-request-parameters.md) - [Route Response Schema](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/route-response-schema.md) - [Exact Output (toAmount)](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/exact-output.md) - [Get a route](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/get-a-route.md) - [Execute the route](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/execute-the-route.md) - [Transaction Types](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/transaction-types.md) - [Hooks](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/hooks.md) - [How do hooks work](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/hooks/how-do-hooks-work.md) - [Build a preHook](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/hooks/build-a-prehook.md) - [Build a postHook](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/hooks/build-a-posthook.md) - [Using the full ERC20 or Native balance in a call](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/hooks/using-the-full-erc20-or-native-balance-in-a-call.md) - [Transfer the remainder to the user](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/hooks/transfer-the-remainder-to-the-user.md) - [Get a route and execute as normal](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/hooks/get-a-route-and-execute-as-normal.md) - [Track status](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/track-status.md) - [Types](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/types.md) - [Collect Fees](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/collect-fees.md) - [Collect Fees](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/collect-fees-1.md) - [Fee collector contract addresses](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/collect-fees-1/fee-collector-contract-addresses.md) - [Wallet History](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/wallet-history.md): The Wallet History API allows you to retrieve all cross-chain transaction records associated with a specific wallet address. This provides a comprehensive view of a user's historical interactions with - [getAllBalances](https://docs.squidrouter.com/api-and-sdk-integration/key-concepts/getallbalances.md) - [Squid Intents](https://docs.squidrouter.com/api-and-sdk-integration/coral-intent-swaps.md) - [Integrating Squid Intents](https://docs.squidrouter.com/api-and-sdk-integration/coral-intent-swaps/integrating-squid-intents.md) - [Become A Solver](https://docs.squidrouter.com/api-and-sdk-integration/coral-intent-swaps/become-a-solver.md) - [Chain Integration Guides](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides.md) - [Bitcoin and Solana](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/bitcoin-and-solana.md) - [Bitcoin Intents](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/bitcoin-intents.md) - [XRPL Integration](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/xrpl-integration.md) - [Swap Widget](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/xrpl-integration/swap-widget.md) - [Payment Widget](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/xrpl-integration/payment-widget.md) - [API & SDK](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/xrpl-integration/api-and-sdk.md) - [Stellar Integration](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/stellar-integration.md) - [Hedera Integration](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/hedera-integration.md) - [Canton Integration](https://docs.squidrouter.com/api-and-sdk-integration/chain-integration-guides/canton-integration.md) - [Supported Chains and Tokens](https://docs.squidrouter.com/chains-and-tokens/get-supported-tokens-and-chains.md) - [Supported Chains by Bridge Type](https://docs.squidrouter.com/chains-and-tokens/coral-intent-swaps.md) - [Circle's EURC Integration Guide](https://docs.squidrouter.com/chains-and-tokens/circles-eurc-integration-guide.md) - [Integrate Your Chain](https://docs.squidrouter.com/chains-and-tokens/integrate-your-chain.md) - [MCP: AI Agent Integration](https://docs.squidrouter.com/squid-ai/mcp.md) - [Squid MPP Adapter](https://docs.squidrouter.com/squid-ai/squid-mpp-adapter.md) - [Contracts](https://docs.squidrouter.com/additional-resources/contracts.md) - [Additional Dev Resources](https://docs.squidrouter.com/additional-resources/additional-dev-resources.md) - [Choose How To Integrate Squid](https://docs.squidrouter.com/additional-resources/additional-dev-resources/choose-how-to-integrate-squid.md) - [Squid x Tenderly](https://docs.squidrouter.com/additional-resources/additional-dev-resources/squid-x-tenderly.md): Mainnet fork dev environment - [Testnet or Mainnet?](https://docs.squidrouter.com/additional-resources/additional-dev-resources/testnet-or-mainnet.md) - [Understanding Gas Payments](https://docs.squidrouter.com/additional-resources/additional-dev-resources/understanding-gas-payments.md) - [SDK easter eggs](https://docs.squidrouter.com/additional-resources/additional-dev-resources/sdk-easter-eggs.md) - [Setting toAmount](https://docs.squidrouter.com/additional-resources/additional-dev-resources/sdk-easter-eggs/setting-toamount.md) - [Advanced set up](https://docs.squidrouter.com/additional-resources/additional-dev-resources/sdk-easter-eggs/advanced-set-up.md) - [Manually approve a route](https://docs.squidrouter.com/additional-resources/additional-dev-resources/sdk-easter-eggs/manually-approve-a-route.md) - [Manually approve an ERC20](https://docs.squidrouter.com/additional-resources/additional-dev-resources/sdk-easter-eggs/manually-approve-an-erc20.md) - [Architecture](https://docs.squidrouter.com/additional-resources/architecture.md) - [FAQ](https://docs.squidrouter.com/additional-resources/architecture/faq.md) - [Liquidity model](https://docs.squidrouter.com/additional-resources/architecture/liquidity-model.md) - [Transaction times and fees](https://docs.squidrouter.com/additional-resources/architecture/transaction-times-and-fees.md) - [Brand Assets](https://docs.squidrouter.com/additional-resources/brand-assets.md) - ["Powered by Squid" Policy](https://docs.squidrouter.com/additional-resources/brand-assets/powered-by-squid-policy.md) - [Compliance & Security](https://docs.squidrouter.com/additional-resources/compliance-and-security.md) - [Audits & Security](https://docs.squidrouter.com/additional-resources/audits-and-security.md) - [Contact](https://docs.squidrouter.com/additional-resources/contact.md) - [SDK](https://docs.squidrouter.com/changelog/sdk.md) - [v1.3](https://docs.squidrouter.com/changelog/sdk/v1.3.md) - [v1.2](https://docs.squidrouter.com/changelog/sdk/v1.2.md): v1.2 Release Notes - [API](https://docs.squidrouter.com/changelog/api.md) - [v1.9](https://docs.squidrouter.com/changelog/api/v1.9.md): API v1.9 Release Notes - [v1.8](https://docs.squidrouter.com/changelog/api/v1.8.md): API v1.8 Release Notes - [v1.7](https://docs.squidrouter.com/changelog/api/v1.7.md): API v1.7 Release Notes - [v1.6](https://docs.squidrouter.com/changelog/api/v1.6.md): API v1.6 Release Notes - [Old v2 Documentation (Deprecated)](https://docs.squidrouter.com/old-v2-documentation-deprecated.md) - [Interchain Token(ITS) Listings](https://docs.squidrouter.com/old-v2-documentation-deprecated/interchain-token-its-listings.md) - [How To List](https://docs.squidrouter.com/old-v2-documentation-deprecated/interchain-token-its-listings/how-to-list.md) - [Add A Widget](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget.md) - [Swap widget](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget.md) - [Getting Started](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/getting-started.md): Supported environments, chains, tokens and wallets - [Installing the Widget](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/installing-the-widget.md): Preparing to integrate the widget into your app - [React Installation](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/react-installation.md): Installing the React component - [NextJS Installation](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/nextjs-installation.md): Integrating the widget into a NextJS app - [Iframe Installation](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/iframe-installation.md): Integrating the widget as an Iframe - [Customization Guide](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/customization-guide.md) - [Default User Settings](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/customization-guide/default-user-settings.md) - [Theme Customization](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/customization-guide/theme-customization.md) - [Configuring Content](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/customization-guide/configuring-content.md) - [Default Chains and Tokens](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/customization-guide/default-chains-and-tokens.md) - [Configuration Types](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/customization-guide/configuration-types.md) - [Collect fees](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/customization-guide/collect-fees.md) - [Information for Integrators](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/information-for-integrators.md): Here you will find a brief onboarding guide to ensure the integration is as smooth as possible for your team and users - [Set default chains and tokens via URL](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/set-default-chains-and-tokens-via-url.md) - [Errors](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/widget/errors.md): Here is a list of errors that some users were facing that have a known fix - [Stake widget](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/stake-widget.md) - [Installing the Widget](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/stake-widget/installing-the-widget.md): Preparing to integrate the widget into your app - [Configuration](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/stake-widget/configuration.md): Staking widget configuration - [Importing The widget](https://docs.squidrouter.com/old-v2-documentation-deprecated/add-a-widget/stake-widget/importing-the-widget.md) - [Quick Start](https://docs.squidrouter.com/old-v2-documentation-deprecated/quick-start.md) - [API](https://docs.squidrouter.com/old-v2-documentation-deprecated/api.md) - [Swap & Bridge Example](https://docs.squidrouter.com/old-v2-documentation-deprecated/api/swap-and-bridge-example.md) - [Staking Example](https://docs.squidrouter.com/old-v2-documentation-deprecated/api/staking-example.md) - [Cross-chain NFT Purchase Example](https://docs.squidrouter.com/old-v2-documentation-deprecated/api/cross-chain-nft-purchase-example.md) - [SDK](https://docs.squidrouter.com/old-v2-documentation-deprecated/sdk.md) - [Cross-chain Swap Example](https://docs.squidrouter.com/old-v2-documentation-deprecated/sdk/cross-chain-swap-example.md) - [Staking Example](https://docs.squidrouter.com/old-v2-documentation-deprecated/sdk/staking-example.md) - [Cross-chain NFT Purchase Example](https://docs.squidrouter.com/old-v2-documentation-deprecated/sdk/cross-chain-nft-purchase-example.md) - [Key Concepts](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts.md) - [Route Request Parameters](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/route-request-parameters.md) - [Get a route](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/get-a-route.md) - [Execute the route](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/execute-the-route.md) - [Hooks](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks.md) - [How do hooks work](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks/how-do-hooks-work.md) - [Build a preHook](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks/build-a-prehook.md) - [Build a postHook](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks/build-a-posthook.md) - [Using the full ERC20 or Native balance in a call](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks/using-the-full-erc20-or-native-balance-in-a-call.md) - [Transfer the remainder to the user](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks/transfer-the-remainder-to-the-user.md) - [Add your hooks to a route request, or widget](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks/add-your-hooks-to-a-route-request-or-widget.md) - [Get a route and execute as normal](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/hooks/get-a-route-and-execute-as-normal.md) - [Boost](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/boost.md) - [Track status](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/track-status.md) - [Types](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/types.md) - [Collect Fees](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/collect-fees.md) - [Collect Fees](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/collect-fees-1.md) - [Fee collector contract addresses](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/collect-fees-1/fee-collector-contract-addresses.md) - [Get supported tokens and chains](https://docs.squidrouter.com/old-v2-documentation-deprecated/key-concepts/get-supported-tokens-and-chains.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.squidrouter.com/getting-started/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.