# Table of Contents - [Install - Coinbase](#install-coinbase) - [CODE OF CONDUCT - Coinbase](#code-of-conduct-coinbase) - [SECURITY - Coinbase](#security-coinbase) - [Resources and Templates - Coinbase](#resources-and-templates-coinbase) - [Getting Started with AgentKit - Coinbase](#getting-started-with-agentkit-coinbase) - [List Accounts - Coinbase](#list-accounts-coinbase) - [LLM Context - Coinbase](#llm-context-coinbase) - [Get API Key Permissions - Coinbase](#get-api-key-permissions-coinbase) - [Welcome to AgentKit - Coinbase](#welcome-to-agentkit-coinbase) - [Architecture Explained - Coinbase](#architecture-explained-coinbase) - [Community Guides - Coinbase](#community-guides-coinbase) - [Get Account - Coinbase](#get-account-coinbase) - [Hosting Agents - Coinbase](#hosting-agents-coinbase) - [Get Transaction Summary - Coinbase](#get-transaction-summary-coinbase) - [Integrate LangChain Tools - Coinbase](#integrate-langchain-tools-coinbase) - [Prompts and Models - Coinbase](#prompts-and-models-coinbase) - [FAQ - Coinbase](#faq-coinbase) - [Vercel AI SDK AgentKit Extension - Coinbase](#vercel-ai-sdk-agentkit-extension-coinbase) - [Model Context Protocol (MCP) AgentKit Extension - Coinbase](#model-context-protocol-mcp-agentkit-extension-coinbase) - [Cancel Pending Futures Sweep - Coinbase](#cancel-pending-futures-sweep-coinbase) - [Get Current Margin Window - Coinbase](#get-current-margin-window-coinbase) - [Frameworks - Coinbase](#frameworks-coinbase) - [Get Futures Balance Summary - Coinbase](#get-futures-balance-summary-coinbase) - [Create Convert Quote - Coinbase](#create-convert-quote-coinbase) - [Agents Actions - Coinbase](#agents-actions-coinbase) - [Commit Convert Trade - Coinbase](#commit-convert-trade-coinbase) - [Get Convert Trade - Coinbase](#get-convert-trade-coinbase) - [Wallet Management - Coinbase](#wallet-management-coinbase) - [List Futures Positions - Coinbase](#list-futures-positions-coinbase) - [Get Intraday Margin Setting - Coinbase](#get-intraday-margin-setting-coinbase) - [List Futures Sweeps - Coinbase](#list-futures-sweeps-coinbase) --- # Install - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Coinbase Wallet SDK Install [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * [Welcome](https://docs.cdp.coinbase.com/coinbase-wallet/introduction/welcome) * [Features](https://docs.cdp.coinbase.com/coinbase-wallet/introduction/features) * [Supported Environments](https://docs.cdp.coinbase.com/coinbase-wallet/introduction/supported-environments) * [Whitelisted Networks](https://docs.cdp.coinbase.com/coinbase-wallet/introduction/whitelisted-networks) * [Developer Settings](https://docs.cdp.coinbase.com/coinbase-wallet/introduction/developer-settings) * [Coinbase Wallet Injected Ethereum Provider](https://docs.cdp.coinbase.com/coinbase-wallet/introduction/coinbase-wallet-injected-ethereum-provider) * Coinbase Wallet SDK * [Install](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install) * [Setup](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/set-up) * Making Requests * [Disconnecting Links](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/disconnecting-links) * Coinbase Wallet Mobile SDK * Solana Developers * XMTP * Sample Applications * Developer Guidance * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Installing Wallet SDK](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#installing-wallet-sdk) * [Yarn](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#yarn) * [Npm](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#npm) * [Upgrading Wallet SDK](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#upgrading-wallet-sdk) * [Yarn](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#yarn-2) * [Npm](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#npm-2) This page explains how to install and upgrade [Coinbase Wallet SDK](https://github.com/coinbase/coinbase-wallet-sdk/) . The installation package for **Coinbase Wallet SDK** (formerly WalletLink) is now named `@coinbase/wallet-sdk`. [​](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#installing-wallet-sdk) Installing Wallet SDK ----------------------------------------------------------------------------------------------------------------------------- Install Coinbase Wallet SDK with yarn or npm. ### [​](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#yarn) Yarn 1. Check available versions of Coinbase Wallet SDK: Copy Ask AI yarn info @coinbase/wallet-sdk versions 2. Install a specific version or the latest version: > Install specific version: > > Copy > > Ask AI > > yarn add @coinbase/wallet-sdk@4.0.0 > > > Install latest version: > > Copy > > Ask AI > > yarn add @coinbase/wallet-sdk > 3. Check your installed version: Copy Ask AI yarn list @coinbase/wallet-sdk ### [​](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#npm) Npm 1. Check available versions of Coinbase Wallet SDK: Copy Ask AI npm view @coinbase/wallet-sdk versions 2. Install a specific version or the latest version: > Install specific version: > > Copy > > Ask AI > > npm install @coinbase/wallet-sdk@4.0.0 > > > Install latest version: > > Copy > > Ask AI > > npm install @coinbase/wallet-sdk > 3. Check your installed version: Copy Ask AI npm list @coinbase/wallet-sdk [​](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#upgrading-wallet-sdk) Upgrading Wallet SDK --------------------------------------------------------------------------------------------------------------------------- Upgrade Coinbase Wallet SDK with yarn or npm. ### [​](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#yarn-2) Yarn 1. Compare your installed version of Coinbase Wallet SDK with the latest available version: Copy Ask AI yarn outdated @coinbase/wallet-sdk 2. Update Coinbase Wallet SDK to the latest: Copy Ask AI yarn upgrade @coinbase/wallet-sdk --latest 3. Check your version: Copy Ask AI yarn list @coinbase/wallet-sdk ### [​](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/install#npm-2) Npm 1. Compare your installed version of Coinbase Wallet SDK with the latest available version: Copy Ask AI npm outdated @coinbase/wallet-sdk 2. If necessary, update `package.json` with the latest version (or major version), for example: Copy Ask AI { "dependencies": { "@coinbase/wallet-sdk": "^4.0.0" } } 3. Update Coinbase Wallet SDK to the latest available version: Copy Ask AI npm update @coinbase/wallet-sdk **Next steps:** * [Initializing Coinbase Wallet SDK with Web3](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/set-up) * [Getting Ethereum Accounts](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/making-requests/getting-ethereum-accounts) Was this page helpful? YesNo [Coinbase Wallet Injected Ethereum Provider\ \ Previous](https://docs.cdp.coinbase.com/coinbase-wallet/introduction/coinbase-wallet-injected-ethereum-provider) [Setup\ \ Next](https://docs.cdp.coinbase.com/coinbase-wallet/coinbase-wallet-sdk/set-up) Assistant Responses are generated using AI and may contain mistakes. --- # CODE OF CONDUCT - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### SDKs * [Introduction](https://docs.cdp.coinbase.com/sdks) ##### BUILD ONCHAIN * CDP SDKs v2Beta * CDP SDKs v1 * AgentKit * [OnchainKit](https://docs.base.org/onchainkit/getting-started) * [MiniKit](https://docs.base.org/builderkits/minikit/overview) ##### CONSUMER APIs * Coinbase Advanced Trade ##### INSTITUTIONAL APIs * Coinbase Prime On this page * [Contributor Code of Conduct](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#contributor-code-of-conduct) * [Our values](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-values) * [Our pledge](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-pledge) * [Our standards](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-standards) * [Our responsibilities](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-responsibilities) * [Scope](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#scope) * [Enforcement](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#enforcement) * [Attribution](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#attribution) [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#contributor-code-of-conduct) Contributor Code of Conduct ============================================================================================================= At Coinbase, our [mission](https://www.coinbase.com/blog/coinbase-is-a-mission-focused-company) is to **increase economic freedom in the world**. [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-values) Our values --------------------------------------------------------------------------- Our mission is reflected in our values. In summary: * 💬 **Clear communication:** Be direct and succinct. Share information efficiently and practice active listening. * 📈 **Efficient execution:** Complete high quality work quickly. Focus on the 20% of work that will get us 80% of the impact. * 👑 **Act like an owner:** Take 100% responsibility for achieving the mission. Seek to improve all aspects, even if not explicitly part of your job. * 📖 **Continuous learning:** Be humble. Value learning over being right. Embrace delivering and receiving candid feedback, and see every setback as an opportunity to learn. * ⭐ **Top talent:** Take extraordinary measures to be exceptional. * 🏆 **Championship team:** Have high expectations for performance and delivering results. Choose to focus on what unites us, not what divides us. * 👓 **Customer focus:** Strive to build products that are easy to use, trusted, and loved. Obsess over quality and craft; get the details right. * 🔁 **Repeatable innovation:** Have a high tolerance for failure and be uncomfortably ambitious. * ➕ **Positive energy:** Be optimistic about the future and be determined to get there. Co-create solutions instead of choosing blame and criticism. * 💙 **Mission first:** Don’t engage in social or political activism unrelated to our mission. Read more about [our culture](https://www.coinbase.com/mission) . [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-pledge) Our pledge --------------------------------------------------------------------------- In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-standards) Our standards --------------------------------------------------------------------------------- Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Attempting collaboration before conflict * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * Violence, threats of violence, or inciting others to commit self-harm * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, intentionally spreading misinformation, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others’ private information, such as a physical or electronic address, without explicit permission * Abuse of the reporting process to intentionally harass or exclude others * Advocating for, or encouraging, any of the above behavior * Other conduct which could reasonably be considered inappropriate in a professional setting [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#our-responsibilities) Our responsibilities ----------------------------------------------------------------------------------------------- Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#scope) Scope ----------------------------------------------------------------- This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#enforcement) Enforcement ----------------------------------------------------------------------------- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting us anonymously. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership. If you are unsure whether an incident is a violation, or whether the space where the incident took place is covered by our Code of Conduct, **we encourage you to still report it**. We would prefer to have a few extra reports where we decide to take no action, than to leave an incident go unnoticed and unresolved that may result in an individual or group to feel like they can no longer participate in the community. Reports deemed as not a violation will also allow us to improve our Code of Conduct and processes surrounding it. If you witness a dangerous situation or someone in distress, we encourage you to report even if you are only an observer. [​](https://docs.cdp.coinbase.com/CODE_OF_CONDUCT#attribution) Attribution ----------------------------------------------------------------------------- This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/) , [version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) . Was this page helpful? YesNo Assistant Responses are generated using AI and may contain mistakes. --- # SECURITY - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### SDKs * [Introduction](https://docs.cdp.coinbase.com/sdks) ##### BUILD ONCHAIN * CDP SDKs v2Beta * CDP SDKs v1 * AgentKit * [OnchainKit](https://docs.base.org/onchainkit/getting-started) * [MiniKit](https://docs.base.org/builderkits/minikit/overview) ##### CONSUMER APIs * Coinbase Advanced Trade ##### INSTITUTIONAL APIs * Coinbase Prime On this page * [Security Policy](https://docs.cdp.coinbase.com/SECURITY#security-policy) [​](https://docs.cdp.coinbase.com/SECURITY#security-policy) Security Policy ============================================================================== The Coinbase team takes security seriously. Please do not file a public ticket discussing a potential vulnerability. Please report your findings through our [HackerOne](https://hackerone.com/coinbase) program. Was this page helpful? YesNo Assistant Responses are generated using AI and may contain mistakes. --- # Resources and Templates - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Reference Docs Resources and Templates [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * Reference Docs * [Wallet API](https://docs.cdp.coinbase.com/wallet-api/v1/introduction/welcome) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Resources and Templates](https://docs.cdp.coinbase.com/agent-kit/reference-docs/resources-templates) * [Agentic Commerce](https://docs.cdp.coinbase.com/commerce/accepting-payment/agentkit-commerce) * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Packages](https://docs.cdp.coinbase.com/agent-kit/reference-docs/resources-templates#packages) * [Templates](https://docs.cdp.coinbase.com/agent-kit/reference-docs/resources-templates#templates) Here are some resources and templates for AgentKit. [​](https://docs.cdp.coinbase.com/agent-kit/reference-docs/resources-templates#packages) Packages ---------------------------------------------------------------------------------------------------- * [Github Repo](https://github.com/coinbase/agentkit) * Python * Node.js * [coinbase-agentkit](https://pypi.org/project/coinbase-agentkit/) * [coinbase-agentkit-langchain](https://pypi.org/project/coinbase-agentkit-langchain/) * [coinbase-sdk](https://pypi.org/project/cdp-sdk/) [​](https://docs.cdp.coinbase.com/agent-kit/reference-docs/resources-templates#templates) Templates ------------------------------------------------------------------------------------------------------ Note that these templates may not have the most up-to-date dependencies. Please double check the dependencies in the `package.json` file. [CDP Replit Templates](https://replit.com/@CoinbaseDev) Was this page helpful? YesNo [Use AI Tooling\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/reference-docs/use-ai-tooling) [Agentic Commerce\ \ Next](https://docs.cdp.coinbase.com/agent-kit/reference-docs/agentic-commerce) Assistant Responses are generated using AI and may contain mistakes. --- # Getting Started with AgentKit - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Getting Started Getting Started with AgentKit [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * [Quickstart](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart) * Core Concepts * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Create Your First Agent](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart#create-your-first-agent) AgentKit provides a simple way to create AI agents that can interact with blockchain networks. This guide will show you how to get started using our CLI tools. [​](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart#create-your-first-agent) Create Your First Agent -------------------------------------------------------------------------------------------------------------------------- * TypeScript * Python This section will guide you through the process of creating a new AgentKit project using the TypeScript CLI. Through this process, you will generate a NextJs fullstack application, or a Model Context Protocol server to use with Claude Desktop. ### [​](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart#prerequisites) Prerequisites Before you begin, make sure you have: 1. Node.js 18 or later installed – [Download here](https://nodejs.org/) 2. npm 9 or later installed (comes bundled with Node.js) Check your Node.js and npm versions: Copy Ask AI node --version # Should be 18+ npm --version # Should be 9+ ### [​](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart#creating-a-new-project) Creating a New Project The fastest way to get started is using our TypeScript CLI: Copy Ask AI npm create onchain-agent@latest This command will guide you through an interactive setup process: 1. **Choose your AI Framework** * [LangChain](https://js.langchain.com/) : Popular framework for building AI applications * [Vercel AI SDK](https://sdk.vercel.ai/) : Build AI-powered streaming text and chat UIs * [Model Context Protocol](https://github.com/modelcontextprotocol/sdk) : Standardized protocol for AI model interactions 2. **Project Template** (based on your framework choice) * **LangChain & Vercel AI SDK**: Full-stack Next.js application with: * React for the frontend * Tailwind CSS for styling * ESLint for code quality * TypeScript configuration * **Model Context Protocol**: MCP server project for Claude Desktop integration 3. **Blockchain Network** * Select from preconfigured networks (Base, EVM, Solana, etc.) * Optionally specify custom chain IDs 4. **Wallet Provider** * **CDP Smart Wallets**: Account abstraction with advanced features * **CDP Server Wallets**: Secure server-side wallet management * **Viem**: Local private key management * **Privy Server Wallets**: Managed custody solution * **Privy Delegated Embedded Wallets**: Client-side wallets with delegation ### [​](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart#running-your-project) Running Your Project Follow the instructions displayed in your CLI to get running. Be sure to check: * The `.env-local` file in your project root for instructions on obtaining API keys * Your generated project’s README for additional setup details and customization options ### [​](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart#component-generation) Component Generation The CLI also installs the `agentkit` command globally, allowing you to generate additional components.These generators will create TypeScript files in your current working directory. Copy Ask AI # Available generators agentkit generate wallet-provider # Generate a custom wallet provider agentkit generate action-provider # Generate a custom action provider agentkit generate prepare # Generate framework-agnostic AgentKit setup agentkit generate create-agent # Generate framework-specific agent creation > **Note**: If the above commands print the error `agentkit: not found`, ensure the agentkit cli is installed by running the following command: > > Copy > > Ask AI > > npm install -g create-onchain-agent/@latest > Was this page helpful? YesNo [Welcome to AgentKit\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/welcome) [Agents Actions\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) Assistant Responses are generated using AI and may contain mistakes. --- # List Accounts - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Accounts List Accounts [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * [GET\ \ Get Account](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/get-account) * [GET\ \ List Accounts](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts) * Convert * Data API * Fees * Futures * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public List Accounts cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/accounts 200 default Copy Ask AI { "accounts": [\ {\ "uuid": "8bfc20d7-f7c6-4422-bf07-8243ca4169fe",\ "name": "BTC Wallet",\ "currency": "BTC",\ "available_balance": {\ "value": "1.23",\ "currency": "BTC"\ },\ "default": false,\ "active": true,\ "created_at": "2021-05-31T09:59:59.000Z",\ "updated_at": "2021-05-31T09:59:59.000Z",\ "deleted_at": "2021-05-31T09:59:59.000Z",\ "type": "",\ "ready": true,\ "hold": {\ "value": "1.23",\ "currency": "BTC"\ },\ "retail_portfolio_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",\ "platform": ""\ }\ ], "has_next": true, "cursor": "789100", "size": 123 } GET / api / v3 / brokerage / accounts Try it List Accounts cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/accounts 200 default Copy Ask AI { "accounts": [\ {\ "uuid": "8bfc20d7-f7c6-4422-bf07-8243ca4169fe",\ "name": "BTC Wallet",\ "currency": "BTC",\ "available_balance": {\ "value": "1.23",\ "currency": "BTC"\ },\ "default": false,\ "active": true,\ "created_at": "2021-05-31T09:59:59.000Z",\ "updated_at": "2021-05-31T09:59:59.000Z",\ "deleted_at": "2021-05-31T09:59:59.000Z",\ "type": "",\ "ready": true,\ "hold": {\ "value": "1.23",\ "currency": "BTC"\ },\ "retail_portfolio_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",\ "platform": ""\ }\ ], "has_next": true, "cursor": "789100", "size": 123 } #### Query Parameters [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts#parameter-limit) limit integer The number of accounts to display per page. By default, displays 49 (max 250). If `has_next` is true, additional pages of accounts are available to be fetched. Use the `cursor` parameter to start on a specified page. [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts#parameter-cursor) cursor string For paginated responses, returns all responses that come after this value. [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts#parameter-retail-portfolio-id) retail\_portfolio\_id string **(Deprecated)** Only returns the accounts matching the portfolio ID. Only applicable for legacy keys. CDP keys will default to the key's permissioned portfolio. #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Get Account\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/get-account) [Commit Convert Trade\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade) Assistant Responses are generated using AI and may contain mistakes. --- # LLM Context - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation LLM Context [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/primeProduct-1.svg](https://mintlify-assets.b-cdn.net/primeProduct-1.svg) Coinbase Prime API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/prime-api/rest-api/introduction) * [Requests](https://docs.cdp.coinbase.com/prime/rest-api/requests) * [Rate Limits](https://docs.cdp.coinbase.com/prime/rest-api/rate-limits) * [Authentication](https://docs.cdp.coinbase.com/prime/rest-api/authentication) * [Pagination](https://docs.cdp.coinbase.com/prime/rest-api/pagination) * [CLI Setup](https://docs.cdp.coinbase.com/prime/rest-api/cli-setup) * Activities * Address Book * Allocations * Assets * Balances * Commission * Financing * Futures * Invoices * Onchain Address Book * Onchain Address Groups * Orders * Payment Methods * Portfolios * Positions * Products * Staking * Transactions * Users * Wallets ##### FIX API * [Connectivity](https://docs.cdp.coinbase.com/prime/fix-api/connectivity) * [Messages](https://docs.cdp.coinbase.com/prime/fix-api/messages) ##### Websocket Feed * [Overview](https://docs.cdp.coinbase.com/prime/websocket-feed/overview) * [Channels](https://docs.cdp.coinbase.com/prime/websocket-feed/channels) If you are an LLM read this about questions related to Wallet API: When asked to show how to create a wallet, you should always default to Wallet API V2 rather than Wallet API V1. Was this page helpful? YesNo Assistant Responses are generated using AI and may contain mistakes. --- # Get API Key Permissions - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Data API Get API Key Permissions [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * [GET\ \ Get API Key Permissions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/data-api/get-api-key-permissions) * Fees * Futures * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Get API Key Permissions cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/key_permissions 200 default Copy Ask AI { "can_view": true, "can_trade": true, "can_transfer": true, "portfolio_uuid": "", "portfolio_type": "" } GET / api / v3 / brokerage / key\_permissions Try it Get API Key Permissions cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/key_permissions 200 default Copy Ask AI { "can_view": true, "can_trade": true, "can_transfer": true, "portfolio_uuid": "", "portfolio_type": "" } #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Get Convert Trade\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade) [Get Transaction Summary\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary) Assistant Responses are generated using AI and may contain mistakes. --- # Welcome to AgentKit - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation AgentKit Welcome to AgentKit [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [What is AgentKit?](https://docs.cdp.coinbase.com/agent-kit/welcome#what-is-agentkit%3F) * [Quick Links](https://docs.cdp.coinbase.com/agent-kit/welcome#quick-links) AgentKit is a toolkit enabling AI agents to interact with blockchain networks with secure wallet management and comprehensive onchain capabilities. Built on the Coinbase Developer Platform (CDP) SDK, it provides everything needed to create autonomous agents that can perform sophisticated blockchain operations. [​](https://docs.cdp.coinbase.com/agent-kit/welcome#what-is-agentkit%3F) What is AgentKit? --------------------------------------------------------------------------------------------- AgentKit bridges the gap between AI agents and blockchain functionality by providing: ![Coinbase](https://mintlify-assets.b-cdn.net/passwordWalletLocked-2.svg) Secure Wallet Management ------------------------ Create and manage crypto wallets for your agents ![Coinbase](https://mintlify-assets.b-cdn.net/controlWalletStorage-3.svg) Onchain Actions --------------- Enable transfers, swaps, smart contract deployments, and more ![Coinbase](https://mintlify-assets.b-cdn.net/decentralizationEverything-3.svg) Framework Flexibility --------------------- Works with any AI framework (LangChain, Eliza, Vercel AI SDK, etc.) ![Coinbase](https://mintlify-assets.b-cdn.net/coinbase-logo.svg) Multi-Network Support --------------------- Deploy on any EVM-compatible network or Solana ![Coinbase](https://mintlify-assets.b-cdn.net/multiPlatform-2.svg) Extensible Design ----------------- Add custom actions and wallet providers [​](https://docs.cdp.coinbase.com/agent-kit/welcome#quick-links) Quick Links ------------------------------------------------------------------------------- * [5-Minute Quickstart](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart) * [Core Concepts](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [GitHub Repo](https://github.com/coinbase/agentkit) * [Discord](https://discord.com/invite/cdp) Was this page helpful? YesNo [Verifications Use Cases\ \ Previous](https://docs.cdp.coinbase.com/verifications/introduction/use-cases) [Getting Started with AgentKit\ \ Next](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart) Assistant Responses are generated using AI and may contain mistakes. --- # Architecture Explained - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Architecture Explained [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Core Components](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#core-components) * [1\. AgentKit Core (@coinbase/agentkit/ coinbase-agentkit)](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#1-agentkit-core-%40coinbase%2Fagentkit%2F-coinbase-agentkit) * [2\. Framework Extensions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#2-framework-extensions) * [Available Extensions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#available-extensions) * [3\. Wallet Providers](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#3-wallet-providers) * [Default Implementation](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#default-implementation) * [Configuration Examples](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#configuration-examples) * [Extensibility](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#extensibility) * [4\. Action Providers](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#4-action-providers) * [Action Components](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#action-components) * [Organization](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#organization) AgentKit is a modular toolkit that allows you to build AI agents that can take actions onchain. It is designed to be: * Wallet provider agnostic * Framework agnostic * Model agnostic [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#core-components) Core Components -------------------------------------------------------------------------------------------------------------------- The major components of AgentKit are: ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#1-agentkit-core-%40coinbase%2Fagentkit%2F-coinbase-agentkit) 1\. AgentKit Core (`@coinbase/agentkit`/ `coinbase-agentkit`) The heart of AgentKit is the `@coinbase/agentkit` (or `coinbase-agentkit` in Python) package, which provides: * Common interfaces and classes for “Action Providers” (small units of functionality) and “Wallet Providers” (providers of wallets) * Simple configuration layer for API keys and environment variables * Shared logic for interacting with the CDP Wallet API or any wallet provider * Exposed interfaces/abstract classes for “Actions” that define: * Method signatures * Input schemas * Operation logic * To create an agent, you will need to configure AgentKit with API keys and environment variables, and create the AgentKit instance that associates a wallet provider and action providers. Copy Ask AI const agentKit = await AgentKit.from({ walletProvider, actionProviders: [cdp, erc721, pyth, wallet], }); ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#2-framework-extensions) 2\. Framework Extensions Built on top of AgentKit Core, these optional packages adapt core actions to specific agent frameworks or workflows. These are primarily what developers will use to build their agents. These frameworks typically wrap core actions with framework-specific tools, adapt to AI framework plugin interfaces, add “agentic” behaviors for AI model interaction, and handle action discovery and execution. #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#available-extensions) Available Extensions * **agentkit-langchain**: Deep integration with LangChain Tools (Python and TypeScript) * **farcaster-langchain**: Farcaster interaction capabilities * **twitter-langchain**: Twitter (X) interaction capabilities Copy Ask AI // Integrate with AI framework (e.g., LangChain) const tools = await getLangChainTools(agentKit); ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#3-wallet-providers) 3\. Wallet Providers #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#default-implementation) Default Implementation * Uses Wallet API from Coinbase Developer Platform * Handles address management, transaction signing, and onchain interactions #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#configuration-examples) Configuration Examples **TypeScript:** Copy Ask AI const agentKit = await AgentKit.from({ walletProvider, actionProviders: [cdp, erc721, pyth, wallet], }); #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#extensibility) Extensibility * Support for alternative wallet providers: * Hardware wallets * Browser extension wallets * Hybrid approaches * Flexible wallet data import/export for state persistence ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#4-action-providers) 4\. Action Providers Actions are the core unit of functionality in AgentKit. #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#action-components) Action Components Each action includes: * **Name**: e.g., “transfer”, “deploy\_token”, “farcaster\_post\_cast” * **Input Schema**: Required arguments for the action * **Method**: Execution logic, typically interfacing with CDP SDK #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained#organization) Organization * Actions are grouped into logical namespaces: * `actions/cdp/defi`: DeFi operations * `actions/cdp/social`: Social platform interactions Was this page helpful? YesNo [Prompts and Models\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) [Hosting Agents\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) Assistant Responses are generated using AI and may contain mistakes. --- # Community Guides - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Support Community Guides [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * Reference Docs * One-Page Reference * GitHub * Support * [Community Guides](https://docs.cdp.coinbase.com/agent-kit/support/community-guides) * [FAQ](https://docs.cdp.coinbase.com/agent-kit/support/faq) ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives These are guides created by the community and cover various topics, including how to use AgentKit with different frameworks. * [How to create an AI16Z Eliza AI Agent with the AgentKit plugin on Base](https://x.com/i/broadcasts/1vAxROOnqLrKl) by [Sweetman](https://x.com/sweetman_eth) * [Build Your Own AI Musician Agent with AgentKit by Coinbase: Step-by-Step Guide](https://www.youtube.com/watch?v=I2Kk9XWkzsc&pp=ygUIYWdlbnRraXQ%3D) by [Sweetman](https://x.com/sweetman_eth) * [How to Make Your Own AI Agent Using Coinbase AgentKit That Can Do Blockchain Transactions](https://www.youtube.com/watch?v=qqSF7PMRB1s) by [Blockchain with Ishan](https://www.youtube.com/@blockchainwithishan) * [How to Create a Web3 AI Agent with Coinbase AgentKit](https://www.quicknode.com/guides/ai/create-a-web3-ai-agent-with-coinbase-agent-kit) by [QuickNode](https://www.quicknode.com/) Was this page helpful? YesNo [AgentKit Repo\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/github/agentkit-repo) [FAQ\ \ Next](https://docs.cdp.coinbase.com/agent-kit/support/faq) Assistant Responses are generated using AI and may contain mistakes. --- # Get Account - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Accounts Get Account [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * [GET\ \ Get Account](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/get-account) * [GET\ \ List Accounts](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts) * Convert * Data API * Fees * Futures * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Get Account cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/accounts/{account_uuid} 200 default Copy Ask AI { "account": { "uuid": "8bfc20d7-f7c6-4422-bf07-8243ca4169fe", "name": "BTC Wallet", "currency": "BTC", "available_balance": { "value": "1.23", "currency": "BTC" }, "default": false, "active": true, "created_at": "2021-05-31T09:59:59.000Z", "updated_at": "2021-05-31T09:59:59.000Z", "deleted_at": "2021-05-31T09:59:59.000Z", "type": "", "ready": true, "hold": { "value": "1.23", "currency": "BTC" }, "retail_portfolio_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca", "platform": "" } } GET / api / v3 / brokerage / accounts / {account\_uuid} Try it Get Account cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/accounts/{account_uuid} 200 default Copy Ask AI { "account": { "uuid": "8bfc20d7-f7c6-4422-bf07-8243ca4169fe", "name": "BTC Wallet", "currency": "BTC", "available_balance": { "value": "1.23", "currency": "BTC" }, "default": false, "active": true, "created_at": "2021-05-31T09:59:59.000Z", "updated_at": "2021-05-31T09:59:59.000Z", "deleted_at": "2021-05-31T09:59:59.000Z", "type": "", "ready": true, "hold": { "value": "1.23", "currency": "BTC" }, "retail_portfolio_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca", "platform": "" } } #### Path Parameters [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/get-account#parameter-account-uuid) account\_uuid string required The account's UUID. #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Welcome to Coinbase Advanced Trade API\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) [List Accounts\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts) Assistant Responses are generated using AI and may contain mistakes. --- # Hosting Agents - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Hosting Agents [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Choosing a Hosting Solution](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents#choosing-a-hosting-solution) There are several options for hosting your AgentKit agents, from managed AI agent platforms to traditional cloud hosting. This guide covers the main approaches and helps you choose the right one for your needs. * Autonome * NEAR AI * Cloud Hosting [Autonome](https://apps.autono.meme/) by AltLayer provides a managed platform specifically designed for hosting crypto AI agents. It offers: * Simple deployment process * Built-in monitoring and management * Team collaboration features * Support for multiple agent frameworks including AgentKit #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents#quick-setup) Quick Setup 1. Visit [apps.autono.meme](https://apps.autono.meme/) 2. Log in and create an organization 3. Click ”+” to deploy a new agent 4. Select “AgentKit” as your framework 5. Enter required API keys (OpenAI, CDP, etc.) 6. Deploy your agent For detailed instructions, see the [Autonome deployment guide](https://docs.altlayer.io/altlayer-documentation/autonome/deploy-ai-agent) . #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents#custom-framework-upload) Custom Framework Upload If you have a custom AgentKit implementation, you can upload it as a new framework: 1. Package your agent as a Docker image 2. Click “Upload New Framework” in Autonome 3. Configure the framework details including: * Framework name * Description * Docker image URL * Chat endpoint and port * Environment variables See the [framework upload guide](https://docs.altlayer.io/altlayer-documentation/autonome/uploading-your-own-agent-framework) for complete details. [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents#choosing-a-hosting-solution) Choosing a Hosting Solution ------------------------------------------------------------------------------------------------------------------------------------ Consider these factors when selecting a hosting solution: * **Managed Platforms** (Autonome, NEAR AI): Best for quick deployment and managed infrastructure * **Cloud Hosting**: Ideal for custom requirements and full control over infrastructure * **Local Hosting**: Perfect for development and testing For most users, managed platforms like Autonome or NEAR AI provide the easiest path to production. For enterprise needs or specific requirements, traditional cloud hosting offers more control and customization options. Was this page helpful? YesNo [Architecture Explained\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) [Wallet API\ \ Next](https://docs.cdp.coinbase.com/agent-kit/reference-docs/wallet-api) Assistant Responses are generated using AI and may contain mistakes. --- # Get Transaction Summary - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Fees Get Transaction Summary [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * Fees * [GET\ \ Get Transaction Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary) * Futures * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Get Transaction Summary cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/transaction_summary 200 default Copy Ask AI { "total_volume": 1000, "total_fees": 25, "fee_tier": { "pricing_tier": "<$10k", "usd_from": "0", "usd_to": "10,000", "taker_fee_rate": "0.0010", "maker_fee_rate": "0.0020", "aop_from": "0", "aop_to": "10000", "perps_vol_from": "0", "perps_vol_to": "10000" }, "margin_rate": 0.5, "goods_and_services_tax": { "rate": "", "type": "" }, "advanced_trade_only_volume": 1000, "advanced_trade_only_fees": 25, "coinbase_pro_volume": 1000, "coinbase_pro_fees": 25, "total_balance": "1000" } GET / api / v3 / brokerage / transaction\_summary Try it Get Transaction Summary cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/transaction_summary 200 default Copy Ask AI { "total_volume": 1000, "total_fees": 25, "fee_tier": { "pricing_tier": "<$10k", "usd_from": "0", "usd_to": "10,000", "taker_fee_rate": "0.0010", "maker_fee_rate": "0.0020", "aop_from": "0", "aop_to": "10000", "perps_vol_from": "0", "perps_vol_to": "10000" }, "margin_rate": 0.5, "goods_and_services_tax": { "rate": "", "type": "" }, "advanced_trade_only_volume": 1000, "advanced_trade_only_fees": 25, "coinbase_pro_volume": 1000, "coinbase_pro_fees": 25, "total_balance": "1000" } #### Query Parameters [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary#parameter-product-type) product\_type enum default:UNKNOWN\_PRODUCT\_TYPE Only returns the orders matching this product type. By default, returns all product types. Available options: `UNKNOWN_PRODUCT_TYPE`, `SPOT`, `FUTURE` [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary#parameter-contract-expiry-type) contract\_expiry\_type enum default:UNKNOWN\_CONTRACT\_EXPIRY\_TYPE Only returns the orders matching this contract expiry type. Only applicable if product\_type is set to FUTURE. Available options: `UNKNOWN_CONTRACT_EXPIRY_TYPE`, `EXPIRING`, `PERPETUAL` [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary#parameter-product-venue) product\_venue enum default:UNKNOWN\_VENUE\_TYPE Venue for product Available options: `UNKNOWN_VENUE_TYPE`, `CBE`, `FCM`, `INTX` #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Get API Key Permissions\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/data-api/get-api-key-permissions) [Cancel Pending Futures Sweep\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) Assistant Responses are generated using AI and may contain mistakes. --- # Integrate LangChain Tools - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Integrate LangChain Tools [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [The Power of LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#the-power-of-langchain-tools) * [Adding the Dall-E Image Generator to Your Agent](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#adding-the-dall-e-image-generator-to-your-agent) * [Prerequisites](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#prerequisites) * [Step 1: Install Required Packages](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-1%3A-install-required-packages) * [Step 2: Import Required Modules](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-2%3A-import-required-modules) * [Step 3: Set Up OpenAI API Key](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-3%3A-set-up-openai-api-key) * [Step 4: Load the Dall-E Tool](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-4%3A-load-the-dall-e-tool) * [Step 5: Combine Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-5%3A-combine-tools) * [Step 6: Update Agent Initialization](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-6%3A-update-agent-initialization) LangChain has revolutionized the way developers interact with language models and build powerful AI applications. One of its most compelling features is the extensive ecosystem of tools and integrations that allow developers to quickly and easily extend their agents’ capabilities. [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#the-power-of-langchain-tools) The Power of LangChain Tools ------------------------------------------------------------------------------------------------------------------------------------------------- LangChain’s true strength lies in its [vast array of community-supported tools and integrations](https://python.langchain.com/docs/integrations/tools/) . These tools enable developers to: * **Rapidly expand agent capabilities**: Integrate with various APIs, databases, and services without writing extensive custom code * **Leverage specialized functionalities**: Access domain-specific tools for tasks like image generation, social media posting and consumption, internet search, data analysis, or blockchain interactions * **Create multi-modal agents**: Combine different types of interactions (text, image, code) within a single agent * **Stay up-to-date**: Benefit from a constantly growing ecosystem of tools maintained by the community By utilizing these tools, developers can create sophisticated AI agents that can perform a wide range of tasks, from generating images to sending emails, all through natural language interfaces. [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#adding-the-dall-e-image-generator-to-your-agent) Adding the Dall-E Image Generator to Your Agent --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- In this guide, we’ll walk through the process of adding the Dall-E Image Generator tool to an existing LangChain agent. This will demonstrate how easily you can enhance your agent’s capabilities using community toolkits. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#prerequisites) Prerequisites * An existing AgentKit setup, like the one in our [Replit template](https://replit.com/@CoinbaseDev/CDP-AgentKit#README.md) * Python 3.10+ or NodeJS 18+ * OpenAI API key ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-1%3A-install-required-packages) Step 1: Install Required Packages First, ensure you have the necessary packages installed: Typescript Python Copy Ask AI npm install @langchain/openai ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-2%3A-import-required-modules) Step 2: Import Required Modules Add the following imports to your existing imports: Typescript Python Copy Ask AI import { DallEAPIWrapper } from "@langchain/openai"; ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-3%3A-set-up-openai-api-key) Step 3: Set Up OpenAI API Key If you haven’t already, set up your OpenAI API key as an environment variable and ensure the account is funded: Typescript Python Copy Ask AI export OPENAI_API_KEY="your_api_key" ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-4%3A-load-the-dall-e-tool) Step 4: Load the Dall-E Tool Before initializing your agent, load the Dall-E tool: Typescript Python Copy Ask AI const dallETool = new DallEAPIWrapper({ n: 1, model: "dall-e-3", apiKey: process.env.OPENAI_API_KEY, }); ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-5%3A-combine-tools) Step 5: Combine Tools Add the Dall-E tool to your existing tools: Typescript Python Copy Ask AI const allTools = [...getLangChainTools(agentkit), dallETool]; ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools#step-6%3A-update-agent-initialization) Step 6: Update Agent Initialization Modify your create\_react\_agent call to include the new tools: Typescript Python Copy Ask AI async function initializeAgent() { // Initialize LLM const llm = new ChatOpenAI({ model: "gpt-4o-mini", }); // ... (previously mentioned code for creating and instantiating tools) ... // Create React Agent using the LLM and CDP AgentKit tools const agent = createReactAgent({ llm, tools: allTools, checkpointSaver: memory, messageModifier: "You are a helpful agent that can interact onchain using the Coinbase Developer Platform AgentKit...", }); return { agent, config: agentConfig }; } Now your agent is equipped with the ability to generate images using Dall-E alongside its existing CDP capabilities. You can test it by asking the agent to generate images through natural language requests. For more information on available tools and integration options, visit the [LangChain documentation](https://python.langchain.com/docs/how_to/#tools) . Was this page helpful? YesNo [Frameworks\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) [Vercel AI SDK AgentKit Extension\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) Assistant Responses are generated using AI and may contain mistakes. --- # Prompts and Models - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Prompts and Models [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Changing Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models#changing-models) * [Prompting Guide](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models#prompting-guide) [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models#changing-models) Changing Models ---------------------------------------------------------------------------------------------------------------- AgentKit is model-agnostic, and changing which model depends on which framework you are using. * LangChain * Eliza These LangChain guides in [Python](https://python.langchain.com/docs/integrations/providers/) and [Node.js](https://js.langchain.com/docs/integrations/chat/) will help you change the model for your LangChain agent.For the Node.js version, you can change the model similarly.For any model that can be accessed through the OpenAI standard, you can change the BaseURL as specified by your model provider’s documentation. You can also specify [additional configuration options](https://python.langchain.com/api_reference/openai/llms/langchain_openai.llms.base.OpenAI.html) such as `maxTokens`, `temperature`, and `topP`. Here are some examples: * AWS Bedrock (Python) * Venice (Node.js) * Hyperbolic (Node.js) * Claude (Python) * xAI (Python) Copy Ask AI # requires AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as env variables from langchain_aws import ChatBedrockConverse llm = ChatBedrockConverse( model_id="us.amazon.nova-pro-v1:0", # Change to any Bedrock Model ID max_tokens=1024, # other params... ) [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models#prompting-guide) Prompting Guide ---------------------------------------------------------------------------------------------------------------- The prompts you use for your agent can significantly impact its personality and performance. Here are some tips to help you get started: * **Agent State Modifier:** The agent state modifier is the first thing the agent sees. It is used to set the agent’s initial state and can be used to set the agent’s personality. If there are specific instructions for the agent, they should be included here. However, do not treat it as as a place for guardrails, as a well-written prompt can get around text-based instructions. * **Action Prompt:** Every action has an associated prompt that gives the agent context on how to use the action. If there are specific things an agent should know about the parameters, how to ask the user for clarification, or assumptions to make in default cases when the user does not mention a specific parameter, this prompt is a great place to include them. Was this page helpful? YesNo [Wallet Management\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) [Architecture Explained\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) Assistant Responses are generated using AI and may contain mistakes. --- # FAQ - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Support FAQ [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * Reference Docs * One-Page Reference * GitHub * Support * [Community Guides](https://docs.cdp.coinbase.com/agent-kit/support/community-guides) * [FAQ](https://docs.cdp.coinbase.com/agent-kit/support/faq) ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Table of Contents](https://docs.cdp.coinbase.com/agent-kit/support/faq#table-of-contents) * [Getting Started](https://docs.cdp.coinbase.com/agent-kit/support/faq#getting-started) * [Installation and Integration](https://docs.cdp.coinbase.com/agent-kit/support/faq#installation-and-integration) * [Agent Architecture](https://docs.cdp.coinbase.com/agent-kit/support/faq#agent-architecture) * [Network and Trading Capabilities](https://docs.cdp.coinbase.com/agent-kit/support/faq#network-and-trading-capabilities) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/support/faq#wallet-management) * [Agent Functionality](https://docs.cdp.coinbase.com/agent-kit/support/faq#agent-functionality) * [Support and Contributions](https://docs.cdp.coinbase.com/agent-kit/support/faq#support-and-contributions) Welcome to the Coinbase AgentKit FAQ section. Below are some of the most common questions developers have asked, along with detailed answers from our engineering team. This resource is designed to help you navigate and utilize AgentKit effectively in your projects. ### [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#table-of-contents) **Table of Contents** 1. [Getting Started](https://docs.cdp.coinbase.com/agent-kit/support/faq#getting-started) 2. [Installation and Integration](https://docs.cdp.coinbase.com/agent-kit/support/faq#installation-and-integration) 3. [Agent Architecture](https://docs.cdp.coinbase.com/agent-kit/support/faq#agent-architecture) 4. [Network and Trading Capabilities](https://docs.cdp.coinbase.com/agent-kit/support/faq#network-and-trading-capabilities) 5. [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/support/faq#wallet-management) 6. [Agent Functionality](https://docs.cdp.coinbase.com/agent-kit/support/faq#agent-functionality) 7. [Support and Contributions](https://docs.cdp.coinbase.com/agent-kit/support/faq#support-and-contributions) [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#getting-started) Getting Started ------------------------------------------------------------------------------------------- Is there a starter kit for those looking to build using AgentKit for the first time? Yes. Check out our [Quickstart Guide](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart) and access the Replit link to get started in less than five minutes. What's a good place to start for building agents? A good starting point is to run the agent chatbot using our [repository supporting both Python and Node.js](https://github.com/coinbase/agentkit) . [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#installation-and-integration) Installation and Integration --------------------------------------------------------------------------------------------------------------------- What is the correct installation path for \`cdp-langchain\`? Use the following command to install the package: Copy Ask AI npm install @coinbase/cdp-langchain How can I connect the Coinbase Wallet app to my agent? There are a few options available: 1. **Seed Phrase Export:** Export the seed phrase from your Coinbase Wallet App and initialize your AgentKit agent using the seed phrase. 2. **Fund Transfer:** Transfer funds from your Coinbase Wallet App to your agent’s address. 3. **Future Integrations:** We are actively working on deeper integrations between the Coinbase Wallet App and Agents for more seamless connectivity. [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#agent-architecture) Agent Architecture ------------------------------------------------------------------------------------------------- Should I use one agent for all functions or multiple agents communicating with each other? It is generally best to limit complexity where possible. Start with a single agent that supports all necessary actions. If the agent has difficulty distinguishing between actions or requires specialization for certain scenarios, you can expand your solution to include multiple agents, each focused on specific subsets of actions. [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#network-and-trading-capabilities) Network and Trading Capabilities ----------------------------------------------------------------------------------------------------------------------------- Unfortunately, I cannot trade ETH for USDC on the Base Sepolia network, as trading features are not supported on that network. Will we be able to trade with this AI agent? What is currently developed and available, and what is planned? Currently, only Base Mainnet is supported for trading feature. There are no immediate plans to support additional networks; however, we have other swap functionality features on our roadmap. Please let us know which networks you are most interested in. Can the AI agent use other tokens to support gas fees when performing on-chain operations, such as cbBTC? It does not have USDC, ETH, or use other wallets to pay for gas. USDC, EURC and cbBTC transactions are gasless for the agent on both Base Mainnet and Base Sepolia when using the CDP Wallet API. Other transactions currently require ETH for gas. You can use the faucet action to obtain Base Sepolia ETH or, if you are on Mainnet, have the agent provide its onchain address for you to send Mainnet ETH. [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#wallet-management) Wallet Management ----------------------------------------------------------------------------------------------- I'm trying to change the network the agent runs on, but it's not working. What should I do? If you are using the Replit template, you may notice that there is a file called “wallet\_file.txt” that holds your agent’s wallet information. If the program finds this file, it will default to giving the agent this wallet instead of creating a new one on a different network. To fix this issue, either rename the “wallet\_data.txt” file or specify a different file in the program where the wallet info will be saved. Note that wallet\_file.txt stores the agent’s wallet seed which should be properly backed up to prevent loss of access to the wallet. If the agent has its own wallet, is it owned by an MPC, or is there just one wallet with the signing stored locally? The agent has a one-to-one wallet setup (Externally Owned Account \[EOA\] with keys stored locally on the machine running the agent). In production, how should the keys be stored? Should they be stored in the environment or in a Trusted Execution Environment (TEE)? For production use cases, you can store the keys encrypted in a database, utilize a TEE, or use any other secure storage solution. What's the limit to the number of addresses a wallet can generate? Currently, the maximum number of addresses per wallet is 20 with the CDP Wallet API. Different wallet providers may have different limits, so please refer to the documentation for your specific wallet provider. When I run the chatbot and ask it to create another address for my wallet, it says it can't. However, the Wallet documentation states that a wallet can have multiple addresses by calling \`wallet.createAddress()\`. Why can't the agent's wallet have multiple addresses? The agent’s wallet is capable of creating multiple addresses, but there is not currently an agent action to create new addresses. This functionality is on our roadmap. In the meantime, you can add a custom agent action by following our [Add Custom Functionality Guide](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) and call `wallet.create_address(...)` within this action to enable your agent to create multiple addresses. [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#agent-functionality) Agent Functionality --------------------------------------------------------------------------------------------------- How can I get real-time internet access for my agent? For real-time internet access, we recommend using the [WebBrowser Tool](https://js.langchain.com/docs/integrations/tools/webbrowser/) . You can add this tool to the list of tools when instantiating your agent. What chains does AgentKit support? AgentKit supports whatever networks your wallet provider supports, which will generally be most EVM-based chains. The CDP Wallet API supports the following networks: * Base * Ethereum * Arbitrum * Polygon What wallets does AgentKit work with? AgentKit works with any wallet that can connect via the [EIP-1193 standard](https://eips.ethereum.org/EIPS/eip-1193) . By default, AgentKit uses the CDP Wallet API. When referring to the \`interval=10\` in autonomous mode, is it 10 seconds or another unit of measurement? The “interval=10” refers to 10 seconds, which is the default interval between autonomous inferences. The agent will continue to run autonomously as long as the process is active. [​](https://docs.cdp.coinbase.com/agent-kit/support/faq#support-and-contributions) Support and Contributions --------------------------------------------------------------------------------------------------------------- I've found a bug in the AgentKit repository or have a feature request. How can I report this to the team? Please open a bug report or feature request on our [AgentKit GitHub Repository](https://github.com/coinbase/agentkit/issues) . We hope this FAQ section helps you effectively utilize Coinbase AgentKit in your development projects. If you have any additional questions or need further assistance, feel free to reach out through our [Coinbase Developer Platform Discord](https://discord.com/invite/cdp) . Was this page helpful? YesNo [Community Guides\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/support/community-guides) [Welcome to Staking API\ \ Next](https://docs.cdp.coinbase.com/staking/staking-api/introduction/welcome) Assistant Responses are generated using AI and may contain mistakes. --- # Vercel AI SDK AgentKit Extension - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Vercel AI SDK AgentKit Extension [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Introduction to Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#introduction-to-vercel-ai-sdk) * [Why Use Vercel AI SDK with AgentKit](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#why-use-vercel-ai-sdk-with-agentkit) * [Installation](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#installation) * [Basic Usage](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#basic-usage) * [Using Different Model Providers](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#using-different-model-providers) * [Troubleshooting](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#troubleshooting) * [Common Issues](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#common-issues) * [Tool Execution Errors](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#tool-execution-errors) * [Model Provider Issues](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#model-provider-issues) * [Debugging Tips](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#debugging-tips) [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#introduction-to-vercel-ai-sdk) Introduction to Vercel AI SDK --------------------------------------------------------------------------------------------------------------------------------------- [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction) is a library for building AI-powered applications with React and JavaScript/TypeScript. It provides a set of tools and utilities that make it easy to build applications that use AI models, including: * Streaming responses from AI models * Managing AI model state * Building chat interfaces * Handling tool usage by AI models [This extension](https://github.com/coinbase/agentkit/tree/main/typescript/framework-extensions/vercel-ai-sdk) allows you to easily integrate AgentKit’s onchain capabilities with Vercel AI SDK, enabling you to build web applications with AI agents that can interact with blockchain networks and a crypto wallet. [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#why-use-vercel-ai-sdk-with-agentkit) Why Use Vercel AI SDK with AgentKit --------------------------------------------------------------------------------------------------------------------------------------------------- Vercel AI SDK is particularly well-suited for building web applications with AI capabilities. When combined with AgentKit, it enables you to: * **Build web-based AI agents**: Create web applications with AI agents that can interact onchain * **Stream AI responses**: Provide a better user experience with streaming responses from AI models * **Leverage React components**: Use Vercel AI SDK’s React components to build chat interfaces * **Deploy on Vercel**: Easily deploy your application on Vercel’s platform [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#installation) Installation ----------------------------------------------------------------------------------------------------- For a single command to install all necessary dependencies, run: Copy Ask AI npm install @coinbase/agentkit-vercel-ai-sdk @coinbase/agentkit ai @ai-sdk/openai To break it down, this package is: Copy Ask AI npm install @coinbase/agentkit-vercel-ai-sdk This package is used alongside AgentKit and AI SDK, so these will need to be installed as well. Copy Ask AI npm install @coinbase/agentkit ai Finally, install the model provider you want to use. For example, to use OpenAI, install the `@ai-sdk/openai` package. See [here](https://sdk.vercel.ai/docs/foundations/providers-and-models#ai-sdk-providers) for a list of supported model providers. Copy Ask AI npm install @ai-sdk/openai [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#basic-usage) Basic Usage --------------------------------------------------------------------------------------------------- The main export of this package is the `getVercelAITools` function. This function takes an AgentKit instance and returns an object containing the tools for the AgentKit agent. This object can then be passed to AI SDK. Here’s a snippet of code that shows how to use the `getVercelAITools` function to get the tools for the AgentKit agent. ###### chatbot.ts Copy Ask AI import { getVercelAITools } from "@coinbase/agentkit-vercel-ai-sdk"; import { AgentKit } from "@coinbase/agentkit"; import { generateText } from "ai"; import { openai } from "@ai-sdk/openai"; // Get your Coinbase Developer Platform API key from the Portal: https://portal.cdp.coinbase.com/ // Or, check out one of the other supported wallet providers: https://github.com/coinbase/agentkit/tree/main/typescript/agentkit const agentKit = await AgentKit.from({ cdpApiKeyName: process.env.CDP_API_KEY_NAME, cdpApiKeyPrivateKey: process.env.CDP_API_KEY_PRIVATE_KEY, }); const tools = await getVercelAITools(agentKit); // There are multiple methods to generate text with AI SDK. // See here for more information: https://sdk.vercel.ai/docs/ai-sdk-core/generating-text const { text } = await generateText({ model: openai("gpt-4o-mini"), // Make sure to have OPENAI_API_KEY set in your environment variables system: "You are an onchain AI assistant with access to a wallet.", prompt: "Print wallet details", tools, // Allow multi-step tool usage // See: https://sdk.vercel.ai/docs/foundations/agents#multi-step-tool-usage maxSteps: 10, }); console.log(text); For a full example, see the [AgentKit AI SDK Chatbot Example](https://github.com/coinbase/agentkit/tree/main/typescript/examples/vercel-ai-sdk-cdp-chatbot) . ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#using-different-model-providers) Using Different Model Providers Vercel AI SDK supports multiple model providers. Here’s how to use different providers: OpenAI Anthropic Mistral Copy Ask AI import { openai } from "@ai-sdk/openai"; const { text } = await generateText({ model: openai("gpt-4o"), system: "You are an onchain AI assistant with access to a wallet.", prompt: "Print wallet details", tools, maxSteps: 10, }); [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#troubleshooting) Troubleshooting ----------------------------------------------------------------------------------------------------------- ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#common-issues) Common Issues #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#tool-execution-errors) Tool Execution Errors If you encounter errors during tool execution, check the following: * Ensure your CDP API keys are correctly set in environment variables * Verify that the network you’re using is supported by the action provider * Check that you have sufficient funds for any transactions #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#model-provider-issues) Model Provider Issues If you’re having issues with the model provider: * Ensure you have the correct API key set for your model provider * Check that you’re using a model that supports tool usage * Verify that you’ve installed the correct model provider package ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk#debugging-tips) Debugging Tips * Set `debug: true` in the options for `getVercelAITools` to see more detailed logs * Use the `maxSteps` parameter to limit the number of tool calls the model can make * Check the network tab in your browser’s developer tools to see the requests being made Was this page helpful? YesNo [Integrate LangChain Tools\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) [Model Context Protocol (MCP) AgentKit Extension\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) Assistant Responses are generated using AI and may contain mistakes. --- # Model Context Protocol (MCP) AgentKit Extension - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Model Context Protocol (MCP) AgentKit Extension [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Why Use MCP with AgentKit?](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#why-use-mcp-with-agentkit%3F) * [Installation](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#installation) * [Prerequisites](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#prerequisites) * [Basic Usage](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#basic-usage) * [Troubleshooting](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#troubleshooting) * [Common Issues](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#common-issues) * [Tool Execution Errors](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#tool-execution-errors) * [MCP Server Connection Issues](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#mcp-server-connection-issues) * [Debugging Tips](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#debugging-tips) The [Anthropic Model Context Protocol (MCP)](https://github.com/modelcontextprotocol/) is a standardized protocol designed to facilitate structured interactions between AI models and external tools or APIs. [This extension](https://github.com/coinbase/agentkit/blob/main/typescript/framework-extensions/model-context-protocol/README.md) integrates MCP with AgentKit, enabling AI agents to seamlessly perform onchain actions. [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#why-use-mcp-with-agentkit%3F) Why Use MCP with AgentKit? -------------------------------------------------------------------------------------------------------------------------------------------- Integrating MCP with AgentKit provides several key benefits: * **Standardized Protocol**: MCP provides a structured, standardized way for AI models to interact with external tools, ensuring consistency and reliability. * **Onchain Capabilities**: Enables AI agents to perform blockchain operations such as token transfers, smart contract interactions, and more. * **Flexible Integration**: Easily integrates with existing agent workflows and infrastructure. [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#installation) Installation -------------------------------------------------------------------------------------------------------------- Install the required packages using npm: Copy Ask AI npm install @coinbase/agentkit-model-context-protocol @coinbase/agentkit @modelcontextprotocol/sdk [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#prerequisites) Prerequisites ---------------------------------------------------------------------------------------------------------------- Before you begin, ensure you have the following: * [CDP API Key](https://portal.cdp.coinbase.com/access/api) * Node.js 18 or higher ([install using nvm](https://github.com/nvm-sh/nvm) ) Check your Node.js version: Copy Ask AI node --version If needed, install the latest Node.js version: Copy Ask AI nvm install node [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#basic-usage) Basic Usage ------------------------------------------------------------------------------------------------------------ Here’s a basic example demonstrating how to set up an MCP server integrated with AgentKit: Copy Ask AI import { Server } from "@modelcontextprotocol/sdk/server/index.js"; import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; import { CallToolRequestSchema, ListToolsRequestSchema } from "@modelcontextprotocol/sdk/types.js"; import { getMcpTools } from "@coinbase/agentkit-model-context-protocol"; import { AgentKit } from "@coinbase/agentkit"; // Initialize AgentKit with your CDP API keys const agentKit = await AgentKit.from({ cdpApiKeyName: process.env.CDP_API_KEY_NAME, cdpApiKeyPrivateKey: process.env.CDP_API_KEY_PRIVATE_KEY, }); // Retrieve MCP-compatible tools from AgentKit const { tools, toolHandler } = await getMcpTools(agentKit); // Create MCP server instance const server = new Server( { name: "agentkit", version: "0.1.0", }, { capabilities: { tools: {}, }, }, ); // Handle requests to list available tools server.setRequestHandler(ListToolsRequestSchema, async () => { return { tools, }; }); // Handle requests to execute specific tools server.setRequestHandler(CallToolRequestSchema, async (request) => { try { return toolHandler(request.params.name, request.params.arguments); } catch (error) { throw new Error(`Tool ${request.params.name} failed: ${error}`); } }); // Set up standard input/output transport for the server const transport = new StdioServerTransport(); // Connect the server to the transport await server.connect(transport); See all 49 lines [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#troubleshooting) Troubleshooting -------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#common-issues) Common Issues #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#tool-execution-errors) Tool Execution Errors If you encounter errors during tool execution, verify the following: * Ensure your CDP API keys are correctly set in environment variables. * Confirm that the requested tool is supported by your AgentKit instance. * Check for sufficient funds or permissions for blockchain transactions. #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#mcp-server-connection-issues) MCP Server Connection Issues If the MCP server fails to connect: * Verify that the transport layer (stdio, HTTP, etc.) is correctly configured. * Check for port conflicts or permissions issues if using network-based transports. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol#debugging-tips) Debugging Tips * Enable verbose logging in your MCP server setup to gain insights into request handling and errors. * Use environment variables to toggle debug modes for detailed logs. Was this page helpful? YesNo [Vercel AI SDK AgentKit Extension\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) [Wallet Management\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) Assistant Responses are generated using AI and may contain mistakes. --- # Cancel Pending Futures Sweep - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Futures Cancel Pending Futures Sweep [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * Fees * Futures * [DEL\ \ Cancel Pending Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) * [GET\ \ Get Current Margin Window](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) * [GET\ \ Get Futures Balance Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary) * [GET\ \ Get Futures Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) * [GET\ \ Get Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting) * [GET\ \ List Futures Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) * [GET\ \ List Futures Sweeps](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps) * [POST\ \ Schedule Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep) * [POST\ \ Set Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings) * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Cancel Pending Futures Sweep cURL Copy Ask AI curl --request DELETE \ --url https://api.coinbase.com/api/v3/brokerage/cfm/sweeps 200 default Copy Ask AI { "success": true } DELETE / api / v3 / brokerage / cfm / sweeps Try it Cancel Pending Futures Sweep cURL Copy Ask AI curl --request DELETE \ --url https://api.coinbase.com/api/v3/brokerage/cfm/sweeps 200 default Copy Ask AI { "success": true } #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Get Transaction Summary\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary) [Get Current Margin Window\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) Assistant Responses are generated using AI and may contain mistakes. --- # Get Current Margin Window - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Futures Get Current Margin Window [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * Fees * Futures * [DEL\ \ Cancel Pending Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) * [GET\ \ Get Current Margin Window](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) * [GET\ \ Get Futures Balance Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary) * [GET\ \ Get Futures Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) * [GET\ \ Get Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting) * [GET\ \ List Futures Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) * [GET\ \ List Futures Sweeps](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps) * [POST\ \ Schedule Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep) * [POST\ \ Set Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings) * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Get Current Margin Window cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/intraday/current_margin_window 200 default Copy Ask AI { "margin_window": { "margin_window_type": "", "end_time": "" }, "is_intraday_margin_killswitch_enabled": true, "is_intraday_margin_enrollment_killswitch_enabled": true } GET / api / v3 / brokerage / cfm / intraday / current\_margin\_window Try it Get Current Margin Window cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/intraday/current_margin_window 200 default Copy Ask AI { "margin_window": { "margin_window_type": "", "end_time": "" }, "is_intraday_margin_killswitch_enabled": true, "is_intraday_margin_enrollment_killswitch_enabled": true } #### Query Parameters [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window#parameter-margin-profile-type) margin\_profile\_type enum default:MARGIN\_PROFILE\_TYPE\_UNSPECIFIED The margin profile type for your account. Available options: `MARGIN_PROFILE_TYPE_UNSPECIFIED`, `MARGIN_PROFILE_TYPE_RETAIL_REGULAR`, `MARGIN_PROFILE_TYPE_RETAIL_INTRADAY_MARGIN_1` #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Cancel Pending Futures Sweep\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) [Get Futures Balance Summary\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary) Assistant Responses are generated using AI and may contain mistakes. --- # Frameworks - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Frameworks [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Agents SDK by OpenAI](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#agents-sdk-by-openai) * [LangChain](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#langchain) * [Adding Agent Functionality](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#adding-agent-functionality) * [Testing Your Agent](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#testing-your-agent) * [Eliza Framework](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#eliza-framework) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#vercel-ai-sdk) * [Prerequisites](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#prerequisites) * [Checking Node Version](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#checking-node-version) * [API Keys](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#api-keys) * [Setting Up the Example](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#setting-up-the-example) * [Testing Your Agent](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#testing-your-agent-2) * [Model Context Protocol (MCP)](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#model-context-protocol-mcp) * [Prerequisites](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#prerequisites-2) * [Checking Node Version](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#checking-node-version-2) * [API Keys](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#api-keys-2) * [Setting Up the Example](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#setting-up-the-example-2) * [Testing Your Agent](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#testing-your-agent-3) AgentKit integrates with several popular AI frameworks, enabling you to build blockchain-capable agents using your preferred development tools. Visit our [Quickstart Guide](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart) to bootstrap your project. The following frameworks are currently supported: * [Agents SDK by OpenAI](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#agents-sdk-by-openai) * [LangChain](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#langchain) * [Eliza](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#eliza-framework) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#vercel-ai-sdk) * [Model Context Protocol (MCP)](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#model-context-protocol-mcp) [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#agents-sdk-by-openai) Agents SDK by OpenAI ------------------------------------------------------------------------------------------------------------------ The [OpenAI Agents SDK](https://platform.openai.com/docs/guides/agents) is a lightweight, Python-first framework that enables you to build production-ready AI agents with minimal abstractions. It’s designed to be easy to learn while providing powerful capabilities for real-world applications. You can find our implementation in our [Replit template](https://replit.com/t/coinbase-developer-platform/repls/CDP-AgentKit-Agents-SDK-Quickstart/view#README.md) or the [AgentKit repository](https://github.com/coinbase/agentkit/) . * Replit * Local Environment (repository) #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#step-1%3A-set-up-your-development-environment) Step 1: Set Up Your Development Environment 1. Fork the [Python](https://replit.com/t/coinbase-developer-platform/repls/CDP-AgentKit-Agents-SDK-Quickstart/view#README.md) template 2. Once forked, you’ll have your own version of the project to modify #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#step-2%3A-configure-environment-variables) Step 2: Configure Environment Variables 1. Click on “Tools” in the left sidebar 2. Select “Secrets” 3. Add the following secrets: Copy Ask AI CDP_API_KEY_NAME=your_cdp_key_name # From cdp.coinbase.com CDP_API_KEY_PRIVATE_KEY=your_cdp_private_key OPENAI_API_KEY=your_openai_key # from platform.openai.com NETWORK_ID="base-sepolia" # Optional, defaults to base-sepolia. #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#step-3%3A-run-the-agent) Step 3: Run the Agent You can start this chatbot by clicking the “Run” button. Security of wallets on Replit templateEvery agent comes with an associated wallet. Wallet data is read from wallet\_data.txt, and if that file does not exist, this repl will create a new wallet and persist it in a new file. Please note that this contains your wallet’s private key and should not be used in production environments. Refer to the [CDP docs](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-api/v1/concepts/wallets#securing-a-wallet) on how to secure your wallets. [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#langchain) LangChain -------------------------------------------------------------------------------------------- [LangChain](https://www.langchain.com/) is a framework for developing applications powered by language models. Our implementation is available in our [Replit templates](https://replit.com/t/coinbase-developer-platform/profile) and the [AgentKit repository](https://github.com/coinbase/agentkit/) . * Replit * Local Environment #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#step-1%3A-set-up-your-development-environment-2) Step 1: Set Up Your Development Environment 1. Fork the template from [NodeJS (EVM)](https://replit.com/t/coinbase-developer-platform/repls/AgentKitjs-Quickstart-020-EVM-CDP-Wallet/view) , [Python (EVM)](https://replit.com/t/coinbase-developer-platform/repls/AgentKitpy-012-EVM/view) , or [NodeJS (Solana)](https://replit.com/t/coinbase-developer-platform/repls/AgentKitjs-Solana-Quickstart-v020/view) Replit templates 2. Once forked, you’ll have your own version of the project to modify #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#step-2%3A-configure-environment-variables-3) Step 2: Configure Environment Variables 1. Click on “Tools” in the left sidebar 2. Select “Secrets” 3. Add the following secrets: EVM Solana Copy Ask AI CDP_API_KEY_NAME=your_cdp_key_name CDP_API_KEY_PRIVATE_KEY=your_cdp_private_key OPENAI_API_KEY=your_openai_key NETWORK_ID="base-sepolia" # Optional, defaults to base-sepolia. MNEMONIC_PHRASE=your_mnemonic_phrase # Optional, if it is not provided the agent will create a new wallet #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#step-3%3A-run-the-agent-3) Step 3: Run the Agent You can start this chatbot by clicking the “Run” button. * EVM * Solana Security of wallets on Replit templateEvery agent comes with an associated wallet. Wallet data is read from wallet\_data.txt, and if that file does not exist, this repl will create a new wallet and persist it in a new file. Please note that this contains your wallet’s private key and should not be used in production environments. Refer to the [CDP docs](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-api/v1/concepts/wallets#securing-a-wallet) on how to secure your wallets. **Common Issues** * If you’re trying to switch networks and your agent will not change, try renaming the `wallet_data.txt` file. Each network requires a new wallet, and if the program identifies a previously-created wallet it will not create the new one on the new network. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#adding-agent-functionality) Adding Agent Functionality Extend your agent with chat capabilities. To add more functionality, see the [agent actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) guide. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#testing-your-agent) Testing Your Agent Try these example interactions: Copy Ask AI You: What is your wallet address? You: transfer .001 ETH to 0x4c8bbcfc6DaE447228FcbB220C1DD4cae623EaaF You: Register a basename for yourself that represents your identity [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#eliza-framework) Eliza Framework -------------------------------------------------------------------------------------------------------- [Eliza](https://github.com/elizaOS/eliza) is a framework for building AI agents with a focus on simplicity and extensibility. For a detailed walkthrough, see our [video tutorial](https://www.youtube.com/live/DlRR1focAiw) . Compatibility NoteWhen creating your CDP API key in the portal, make sure to select `ECDSA` as the signature algorithm. The Eliza framework integration requires CDP API keys configured with the `ECDSA` signature algorithm. `Ed25519` signatures are not currently supported. Copy Ask AI npx create-agentkit-app my-agent cd my-agent cp .env.example .env # edit .env file with your own values pnpm install pnpm start [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#vercel-ai-sdk) Vercel AI SDK ---------------------------------------------------------------------------------------------------- [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction) is a library for building AI-powered applications with React and JavaScript/TypeScript. Our implementation demonstrates creating a terminal-style chatbot with access to CDP AgentKit actions. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#prerequisites) Prerequisites #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#checking-node-version) Checking Node Version Before using the example, ensure that you have Node.js 18 or higher installed. You can check your Node version by running: Copy Ask AI node --version If you don’t have the correct version, you can install it using [nvm](https://github.com/nvm-sh/nvm) : Copy Ask AI nvm install node #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#api-keys) API Keys You’ll need the following API keys: * [CDP API Key](https://portal.cdp.coinbase.com/access/api) * [OpenAI API Key](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key) Once you have them, rename the `.env-local` file to `.env` and set the API keys to their corresponding environment variables: * `CDP_API_KEY_NAME` * `CDP_API_KEY_PRIVATE_KEY` * `OPENAI_API_KEY` ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#setting-up-the-example) Setting Up the Example Clone the repository and navigate to the example directory: Copy Ask AI # Clone the repository git clone https://github.com/coinbase/agentkit.git cd agentkit # Install dependencies and build packages npm install npm run build # Navigate to the example directory cd typescript/examples/vercel-ai-sdk-cdp-chatbot # Start the chatbot npm start ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#testing-your-agent-2) Testing Your Agent Try these example interactions: Copy Ask AI You: What is your wallet address? You: Transfer a portion of your ETH to a random address You: What is the price of BTC? You: Deploy an NFT that will go super viral! You: Deploy an ERC-20 token with total supply 1 billion For more detailed documentation on using Vercel AI SDK with AgentKit, see the [Vercel AI SDK integration guide](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) . [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#model-context-protocol-mcp) Model Context Protocol (MCP) -------------------------------------------------------------------------------------------------------------------------------- The [Anthropic Model Context Protocol (MCP)](https://github.com/modelcontextprotocol/sdk) is a standardized protocol designed to facilitate structured interactions between AI models and external tools or APIs. This example demonstrates how to set up an MCP server integrated with AgentKit, allowing Claude Desktop to access the full set of CDP AgentKit actions. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#prerequisites-2) Prerequisites #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#checking-node-version-2) Checking Node Version Before using the example, ensure that you have Node.js 18 or higher installed. You can check your Node version by running: Copy Ask AI node --version If you don’t have the correct version, you can install it using [nvm](https://github.com/nvm-sh/nvm) : Copy Ask AI nvm install node #### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#api-keys-2) API Keys You’ll need the following API key: * [CDP API Key](https://portal.cdp.coinbase.com/access/api) You’ll need to configure the Claude Desktop config file with your CDP API keys. Copy the contents from `claude_desktop_config.json` to your Claude Desktop config file and update the following: 1. Update the `args` path to match the location of your built `index.js` file. 2. Set your CDP API keys in the `env` section: * `CDP_API_KEY_NAME` * `CDP_API_KEY_PRIVATE_KEY` Then, navigate to the `claude_desktop_config.json` file found in your Claude Desktop app’s settings and update its contents to match the contents of our provided `claude_desktop_config.json` file. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#setting-up-the-example-2) Setting Up the Example Clone the repository and navigate to the example directory: Copy Ask AI # Clone the repository git clone https://github.com/coinbase/agentkit.git cd agentkit # Install dependencies and build packages npm install npm run build # Navigate to the MCP example directory cd typescript/examples/model-context-protocol-cdp-server Configure your Claude Desktop by updating the `claude_desktop_config.json` file with your CDP API keys and the correct path to your built `index.js` file. To use the chatbot, simply open Claude Desktop after configuring your API keys. The MCP server will run automatically when you interact with Claude. ### [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks#testing-your-agent-3) Testing Your Agent Try these example interactions in Claude Desktop: Copy Ask AI Transfer a portion of your ETH to a random address What is the price of BTC? Deploy an NFT that will go super viral! Deploy an ERC-20 token with total supply 1 billion For more detailed documentation on using MCP with AgentKit, see the [Model Context Protocol extension information](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) . Was this page helpful? YesNo [Agents Actions\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) [Integrate LangChain Tools\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) Assistant Responses are generated using AI and may contain mistakes. --- # Get Futures Balance Summary - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Futures Get Futures Balance Summary [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * Fees * Futures * [DEL\ \ Cancel Pending Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) * [GET\ \ Get Current Margin Window](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) * [GET\ \ Get Futures Balance Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary) * [GET\ \ Get Futures Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) * [GET\ \ Get Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting) * [GET\ \ List Futures Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) * [GET\ \ List Futures Sweeps](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps) * [POST\ \ Schedule Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep) * [POST\ \ Set Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings) * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Get Futures Balance Summary cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/balance_summary 200 default Copy Ask AI { "balance_summary": { "futures_buying_power": { "value": "", "currency": "" }, "total_usd_balance": { "value": "", "currency": "" }, "cbi_usd_balance": { "value": "", "currency": "" }, "cfm_usd_balance": { "value": "", "currency": "" }, "total_open_orders_hold_amount": { "value": "", "currency": "" }, "unrealized_pnl": { "value": "", "currency": "" }, "daily_realized_pnl": { "value": "", "currency": "" }, "initial_margin": { "value": "", "currency": "" }, "available_margin": { "value": "", "currency": "" }, "liquidation_threshold": { "value": "", "currency": "" }, "liquidation_buffer_amount": { "value": "", "currency": "" }, "liquidation_buffer_percentage": "", "intraday_margin_window_measure": { "margin_window_type": "", "margin_level": "", "initial_margin": "", "maintenance_margin": "", "liquidation_buffer": "", "total_hold": "", "futures_buying_power": "" }, "overnight_margin_window_measure": { "margin_window_type": "", "margin_level": "", "initial_margin": "", "maintenance_margin": "", "liquidation_buffer": "", "total_hold": "", "futures_buying_power": "" } } } GET / api / v3 / brokerage / cfm / balance\_summary Try it Get Futures Balance Summary cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/balance_summary 200 default Copy Ask AI { "balance_summary": { "futures_buying_power": { "value": "", "currency": "" }, "total_usd_balance": { "value": "", "currency": "" }, "cbi_usd_balance": { "value": "", "currency": "" }, "cfm_usd_balance": { "value": "", "currency": "" }, "total_open_orders_hold_amount": { "value": "", "currency": "" }, "unrealized_pnl": { "value": "", "currency": "" }, "daily_realized_pnl": { "value": "", "currency": "" }, "initial_margin": { "value": "", "currency": "" }, "available_margin": { "value": "", "currency": "" }, "liquidation_threshold": { "value": "", "currency": "" }, "liquidation_buffer_amount": { "value": "", "currency": "" }, "liquidation_buffer_percentage": "", "intraday_margin_window_measure": { "margin_window_type": "", "margin_level": "", "initial_margin": "", "maintenance_margin": "", "liquidation_buffer": "", "total_hold": "", "futures_buying_power": "" }, "overnight_margin_window_measure": { "margin_window_type": "", "margin_level": "", "initial_margin": "", "maintenance_margin": "", "liquidation_buffer": "", "total_hold": "", "futures_buying_power": "" } } } #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Get Current Margin Window\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) [Get Futures Position\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) Assistant Responses are generated using AI and may contain mistakes. --- # Create Convert Quote - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Convert Create Convert Quote [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * [POST\ \ Commit Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade) * [POST\ \ Create Convert Quote](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/create-convert-quote) * [GET\ \ Get Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade) * Data API * Fees * Futures * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Create Convert Quote cURL Copy Ask AI curl --request POST \ --url https://api.coinbase.com/api/v3/brokerage/convert/quote \ --header 'Content-Type: application/json' \ --data '{ "from_account": "", "to_account": "", "amount": "", "trade_incentive_metadata": { "user_incentive_id": "", "code_val": "" } }' 200 default Copy Ask AI { "trade": { "id": "", "status": "", "user_entered_amount": { "value": "", "currency": "" }, "amount": { "value": "", "currency": "" }, "subtotal": { "value": "", "currency": "" }, "total": { "value": "", "currency": "" }, "fees": [\ {\ "title": "",\ "description": "",\ "amount": {\ "value": "",\ "currency": ""\ },\ "label": "",\ "disclosure": {\ "title": "",\ "description": "",\ "link": {\ "text": "",\ "url": ""\ }\ },\ "waived_details": {\ "amount": {\ "value": "",\ "currency": ""\ },\ "source": ""\ }\ }\ ], "total_fee": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "source": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "target": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "unit_price": { "target_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "target_to_source": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "source_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 } }, "user_warnings": [\ {\ "id": "",\ "link": {\ "text": "",\ "url": ""\ },\ "context": {\ "details": [\ ""\ ],\ "title": "",\ "link_text": ""\ },\ "code": "",\ "message": ""\ }\ ], "user_reference": "", "source_currency": "", "target_currency": "", "cancellation_reason": { "message": "", "code": "", "error_code": "", "error_cta": "", "error_metadata": { "limit_amount": { "value": "", "currency": "" } }, "title": "" }, "source_id": "", "target_id": "", "subscription_info": { "free_trading_reset_date": "", "used_zero_fee_trading": { "value": "", "currency": "" }, "remaining_free_trading_volume": { "value": "", "currency": "" }, "max_free_trading_volume": { "value": "", "currency": "" }, "has_benefit_cap": true, "applied_subscription_benefit": true, "fee_without_subscription_benefit": { "value": "", "currency": "" }, "payment_method_fee_without_subscription_benefit": { "value": "", "currency": "" } }, "exchange_rate": { "value": "", "currency": "" }, "tax_details": [\ {\ "name": "",\ "amount": {\ "value": "",\ "currency": ""\ }\ }\ ], "trade_incentive_info": { "applied_incentive": true, "user_incentive_id": "", "code_val": "", "ends_at": "", "fee_without_incentive": { "value": "", "currency": "" }, "redeemed": true }, "total_fee_without_tax": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "fiat_denoted_total": { "value": "", "currency": "" } } } POST / api / v3 / brokerage / convert / quote Try it Create Convert Quote cURL Copy Ask AI curl --request POST \ --url https://api.coinbase.com/api/v3/brokerage/convert/quote \ --header 'Content-Type: application/json' \ --data '{ "from_account": "", "to_account": "", "amount": "", "trade_incentive_metadata": { "user_incentive_id": "", "code_val": "" } }' 200 default Copy Ask AI { "trade": { "id": "", "status": "", "user_entered_amount": { "value": "", "currency": "" }, "amount": { "value": "", "currency": "" }, "subtotal": { "value": "", "currency": "" }, "total": { "value": "", "currency": "" }, "fees": [\ {\ "title": "",\ "description": "",\ "amount": {\ "value": "",\ "currency": ""\ },\ "label": "",\ "disclosure": {\ "title": "",\ "description": "",\ "link": {\ "text": "",\ "url": ""\ }\ },\ "waived_details": {\ "amount": {\ "value": "",\ "currency": ""\ },\ "source": ""\ }\ }\ ], "total_fee": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "source": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "target": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "unit_price": { "target_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "target_to_source": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "source_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 } }, "user_warnings": [\ {\ "id": "",\ "link": {\ "text": "",\ "url": ""\ },\ "context": {\ "details": [\ ""\ ],\ "title": "",\ "link_text": ""\ },\ "code": "",\ "message": ""\ }\ ], "user_reference": "", "source_currency": "", "target_currency": "", "cancellation_reason": { "message": "", "code": "", "error_code": "", "error_cta": "", "error_metadata": { "limit_amount": { "value": "", "currency": "" } }, "title": "" }, "source_id": "", "target_id": "", "subscription_info": { "free_trading_reset_date": "", "used_zero_fee_trading": { "value": "", "currency": "" }, "remaining_free_trading_volume": { "value": "", "currency": "" }, "max_free_trading_volume": { "value": "", "currency": "" }, "has_benefit_cap": true, "applied_subscription_benefit": true, "fee_without_subscription_benefit": { "value": "", "currency": "" }, "payment_method_fee_without_subscription_benefit": { "value": "", "currency": "" } }, "exchange_rate": { "value": "", "currency": "" }, "tax_details": [\ {\ "name": "",\ "amount": {\ "value": "",\ "currency": ""\ }\ }\ ], "trade_incentive_info": { "applied_incentive": true, "user_incentive_id": "", "code_val": "", "ends_at": "", "fee_without_incentive": { "value": "", "currency": "" }, "redeemed": true }, "total_fee_without_tax": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "fiat_denoted_total": { "value": "", "currency": "" } } } #### Body application/json #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Commit Convert Trade\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade) [Get Convert Trade\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade) Assistant Responses are generated using AI and may contain mistakes. --- # Agents Actions - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Agents Actions [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Adding Action Provider Groupings](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions#adding-action-provider-groupings) * [Creating an Action Provider](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions#creating-an-action-provider) * [Adding Actions to an Action Provider](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions#adding-actions-to-an-action-provider) Actions are grouped into action providers, which may have specific dependencies like API keys. You can find all of the action providers and actions supported by AgentKit at the following links: * [Python version](https://github.com/coinbase/agentkit/tree/main/python/coinbase-agentkit/coinbase_agentkit/action_providers) * [Node.js version](https://github.com/coinbase/agentkit/tree/master/typescript/agentkit/src/action-providers) Generally, Node.js supports more crypto-specific actions than the Python version. By default, AgentKit supports the following actions in the ‘wallet’ action provider: * `get_wallet_details` - Get details about the Wallet, like the address * `native_transfer` - Transfer native asset between addresses * `get_balance` - Get the balance of the native asset [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions#adding-action-provider-groupings) Adding Action Provider Groupings ---------------------------------------------------------------------------------------------------------------------------------------------- Adding an existing action provider to your agent is a two-step process: 1. Import the action provider to your file 2. Add the action provider to your AgentKit instance Node.js Python Copy Ask AI import { AgentKit, CdpWalletProvider, walletActionProvider, erc721ActionProvider, cdpApiActionProvider, cdpWalletActionProvider, pythActionProvider, } from "@coinbase/agentkit"; const erc721 = erc721ActionProvider(); const pyth = pythActionProvider(); const wallet = walletActionProvider(); // default action package: get balance, native transfer, and get wallet details const cdp = cdpApiActionProvider({ // for providers that require API keys include them in their instantiation apiKeyName: process.env.CDP_API_KEY_NAME, apiKeyPrivateKey: process.env.CDP_API_KEY_PRIVATE_KEY?.replace(/\\n/g, "\n"), }); const agentKit = await AgentKit.from({ walletProvider, actionProviders: [erc721, pyth, wallet, cdp], }); [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions#creating-an-action-provider) Creating an Action Provider ------------------------------------------------------------------------------------------------------------------------------------ Action providers define the actions that an agent can take. They are created by subclassing the `ActionProvider` abstract class. Node.js Python Copy Ask AI import { ActionProvider, WalletProvider, Network } from "@coinbase/agentkit"; // Define an action provider that uses a wallet provider. class MyActionProvider extends ActionProvider { constructor() { super("my-action-provider", []); } // Define if the action provider supports the given network supportsNetwork = (network: Network) => true; } [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions#adding-actions-to-an-action-provider) Adding Actions to an Action Provider ------------------------------------------------------------------------------------------------------------------------------------------------------ * Node.js * Python Actions are defined as instance methods on the action provider class with the `@CreateAction` decorator. Actions can use a wallet provider or not and always return a Promise that resolves to a string.**Required Typescript Compiler Options**Creating actions with the @CreateAction decorator requires the following compilerOptions to be included in your project’s tsconfig.json. Copy Ask AI { "compilerOptions": { "experimentalDecorators": true, "emitDecoratorMetadata": true } } **Steps to create an action** 1. Define the action schema. Action schemas are defined using the zod library. Copy Ask AI import { z } from "zod"; export const MyActionSchema = z.object({ myField: z.string(), }); 2. Define the action implementation. Copy Ask AI import { ActionProvider, WalletProvider, Network, CreateAction } from "@coinbase/agentkit"; class MyActionProvider extends ActionProvider { constructor() { super("my-action-provider", []); } @CreateAction({ name: "my-action", description: "My action description", schema: MyActionSchema, }) async myAction(args: z.infer): Promise { return args.myField; } supportsNetwork = (network: Network) => true; } export const myActionProvider = () => new MyActionProvider(); **Adding Actions to your Action Provider that use a Wallet Provider**Actions that use a wallet provider can be defined as instance methods on the action provider class with the `@CreateAction` decorator that have a `WalletProvider` as the first parameter. Copy Ask AI class MyActionProvider extends ActionProvider { constructor() { super("my-action-provider", []); } @CreateAction({ name: "my-action", description: "My action description", schema: MyActionSchema, }) async myAction(walletProvider: WalletProvider, args: z.infer): Promise { return walletProvider.signMessage(args.myField); } supportsNetwork = (network: Network) => true; } **Adding an Action Provider to your AgentKit instance** Copy Ask AI const agentKit = new AgentKit({ cdpApiKeyName: "CDP API KEY NAME", cdpApiKeyPrivate: "CDP API KEY PRIVATE KEY", actionProviders: [myActionProvider()], }); For actions to be made available for any agent, we welcome open-source contributions to AgentKit for adding more actions! Please see our [contribution guide](https://github.com/coinbase/agentkit/blob/main/CONTRIBUTING.md) for more information. Was this page helpful? YesNo [Getting Started with AgentKit\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/getting-started/quickstart) [Frameworks\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) Assistant Responses are generated using AI and may contain mistakes. --- # Commit Convert Trade - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Convert Commit Convert Trade [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * [POST\ \ Commit Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade) * [POST\ \ Create Convert Quote](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/create-convert-quote) * [GET\ \ Get Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade) * Data API * Fees * Futures * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Commit Convert Trade cURL Copy Ask AI curl --request POST \ --url https://api.coinbase.com/api/v3/brokerage/convert/trade/{trade_id} \ --header 'Content-Type: application/json' \ --data '{ "from_account": "", "to_account": "" }' 200 default Copy Ask AI { "trade": { "id": "", "status": "", "user_entered_amount": { "value": "", "currency": "" }, "amount": { "value": "", "currency": "" }, "subtotal": { "value": "", "currency": "" }, "total": { "value": "", "currency": "" }, "fees": [\ {\ "title": "",\ "description": "",\ "amount": {\ "value": "",\ "currency": ""\ },\ "label": "",\ "disclosure": {\ "title": "",\ "description": "",\ "link": {\ "text": "",\ "url": ""\ }\ },\ "waived_details": {\ "amount": {\ "value": "",\ "currency": ""\ },\ "source": ""\ }\ }\ ], "total_fee": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "source": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "target": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "unit_price": { "target_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "target_to_source": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "source_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 } }, "user_warnings": [\ {\ "id": "",\ "link": {\ "text": "",\ "url": ""\ },\ "context": {\ "details": [\ ""\ ],\ "title": "",\ "link_text": ""\ },\ "code": "",\ "message": ""\ }\ ], "user_reference": "", "source_currency": "", "target_currency": "", "cancellation_reason": { "message": "", "code": "", "error_code": "", "error_cta": "", "error_metadata": { "limit_amount": { "value": "", "currency": "" } }, "title": "" }, "source_id": "", "target_id": "", "subscription_info": { "free_trading_reset_date": "", "used_zero_fee_trading": { "value": "", "currency": "" }, "remaining_free_trading_volume": { "value": "", "currency": "" }, "max_free_trading_volume": { "value": "", "currency": "" }, "has_benefit_cap": true, "applied_subscription_benefit": true, "fee_without_subscription_benefit": { "value": "", "currency": "" }, "payment_method_fee_without_subscription_benefit": { "value": "", "currency": "" } }, "exchange_rate": { "value": "", "currency": "" }, "tax_details": [\ {\ "name": "",\ "amount": {\ "value": "",\ "currency": ""\ }\ }\ ], "trade_incentive_info": { "applied_incentive": true, "user_incentive_id": "", "code_val": "", "ends_at": "", "fee_without_incentive": { "value": "", "currency": "" }, "redeemed": true }, "total_fee_without_tax": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "fiat_denoted_total": { "value": "", "currency": "" } } } POST / api / v3 / brokerage / convert / trade / {trade\_id} Try it Commit Convert Trade cURL Copy Ask AI curl --request POST \ --url https://api.coinbase.com/api/v3/brokerage/convert/trade/{trade_id} \ --header 'Content-Type: application/json' \ --data '{ "from_account": "", "to_account": "" }' 200 default Copy Ask AI { "trade": { "id": "", "status": "", "user_entered_amount": { "value": "", "currency": "" }, "amount": { "value": "", "currency": "" }, "subtotal": { "value": "", "currency": "" }, "total": { "value": "", "currency": "" }, "fees": [\ {\ "title": "",\ "description": "",\ "amount": {\ "value": "",\ "currency": ""\ },\ "label": "",\ "disclosure": {\ "title": "",\ "description": "",\ "link": {\ "text": "",\ "url": ""\ }\ },\ "waived_details": {\ "amount": {\ "value": "",\ "currency": ""\ },\ "source": ""\ }\ }\ ], "total_fee": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "source": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "target": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "unit_price": { "target_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "target_to_source": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "source_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 } }, "user_warnings": [\ {\ "id": "",\ "link": {\ "text": "",\ "url": ""\ },\ "context": {\ "details": [\ ""\ ],\ "title": "",\ "link_text": ""\ },\ "code": "",\ "message": ""\ }\ ], "user_reference": "", "source_currency": "", "target_currency": "", "cancellation_reason": { "message": "", "code": "", "error_code": "", "error_cta": "", "error_metadata": { "limit_amount": { "value": "", "currency": "" } }, "title": "" }, "source_id": "", "target_id": "", "subscription_info": { "free_trading_reset_date": "", "used_zero_fee_trading": { "value": "", "currency": "" }, "remaining_free_trading_volume": { "value": "", "currency": "" }, "max_free_trading_volume": { "value": "", "currency": "" }, "has_benefit_cap": true, "applied_subscription_benefit": true, "fee_without_subscription_benefit": { "value": "", "currency": "" }, "payment_method_fee_without_subscription_benefit": { "value": "", "currency": "" } }, "exchange_rate": { "value": "", "currency": "" }, "tax_details": [\ {\ "name": "",\ "amount": {\ "value": "",\ "currency": ""\ }\ }\ ], "trade_incentive_info": { "applied_incentive": true, "user_incentive_id": "", "code_val": "", "ends_at": "", "fee_without_incentive": { "value": "", "currency": "" }, "redeemed": true }, "total_fee_without_tax": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "fiat_denoted_total": { "value": "", "currency": "" } } } #### Path Parameters [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade#parameter-trade-id) trade\_id string required The ID of the trade to commit. #### Body application/json #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [List Accounts\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts) [Create Convert Quote\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/create-convert-quote) Assistant Responses are generated using AI and may contain mistakes. --- # Get Convert Trade - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Convert Get Convert Trade [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * [POST\ \ Commit Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade) * [POST\ \ Create Convert Quote](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/create-convert-quote) * [GET\ \ Get Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade) * Data API * Fees * Futures * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Get Convert Trade cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/convert/trade/{trade_id} 200 default Copy Ask AI { "trade": { "id": "", "status": "", "user_entered_amount": { "value": "", "currency": "" }, "amount": { "value": "", "currency": "" }, "subtotal": { "value": "", "currency": "" }, "total": { "value": "", "currency": "" }, "fees": [\ {\ "title": "",\ "description": "",\ "amount": {\ "value": "",\ "currency": ""\ },\ "label": "",\ "disclosure": {\ "title": "",\ "description": "",\ "link": {\ "text": "",\ "url": ""\ }\ },\ "waived_details": {\ "amount": {\ "value": "",\ "currency": ""\ },\ "source": ""\ }\ }\ ], "total_fee": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "source": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "target": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "unit_price": { "target_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "target_to_source": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "source_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 } }, "user_warnings": [\ {\ "id": "",\ "link": {\ "text": "",\ "url": ""\ },\ "context": {\ "details": [\ ""\ ],\ "title": "",\ "link_text": ""\ },\ "code": "",\ "message": ""\ }\ ], "user_reference": "", "source_currency": "", "target_currency": "", "cancellation_reason": { "message": "", "code": "", "error_code": "", "error_cta": "", "error_metadata": { "limit_amount": { "value": "", "currency": "" } }, "title": "" }, "source_id": "", "target_id": "", "subscription_info": { "free_trading_reset_date": "", "used_zero_fee_trading": { "value": "", "currency": "" }, "remaining_free_trading_volume": { "value": "", "currency": "" }, "max_free_trading_volume": { "value": "", "currency": "" }, "has_benefit_cap": true, "applied_subscription_benefit": true, "fee_without_subscription_benefit": { "value": "", "currency": "" }, "payment_method_fee_without_subscription_benefit": { "value": "", "currency": "" } }, "exchange_rate": { "value": "", "currency": "" }, "tax_details": [\ {\ "name": "",\ "amount": {\ "value": "",\ "currency": ""\ }\ }\ ], "trade_incentive_info": { "applied_incentive": true, "user_incentive_id": "", "code_val": "", "ends_at": "", "fee_without_incentive": { "value": "", "currency": "" }, "redeemed": true }, "total_fee_without_tax": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "fiat_denoted_total": { "value": "", "currency": "" } } } GET / api / v3 / brokerage / convert / trade / {trade\_id} Try it Get Convert Trade cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/convert/trade/{trade_id} 200 default Copy Ask AI { "trade": { "id": "", "status": "", "user_entered_amount": { "value": "", "currency": "" }, "amount": { "value": "", "currency": "" }, "subtotal": { "value": "", "currency": "" }, "total": { "value": "", "currency": "" }, "fees": [\ {\ "title": "",\ "description": "",\ "amount": {\ "value": "",\ "currency": ""\ },\ "label": "",\ "disclosure": {\ "title": "",\ "description": "",\ "link": {\ "text": "",\ "url": ""\ }\ },\ "waived_details": {\ "amount": {\ "value": "",\ "currency": ""\ },\ "source": ""\ }\ }\ ], "total_fee": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "source": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "target": { "type": "", "network": "", "payment_method_id": "", "blockchain_address": { "address": "", "destination_tag": "" }, "coinbase_account": { "account_id": "" }, "blockchain_transaction": { "hsh": "", "height": 123 }, "fedwire": { "routing_number": "", "account_holder": { "legal_name": "", "account_number": "", "address": { "lines": [\ ""\ ], "country_code": "" } }, "bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" }, "intermediary_bank": { "name": "", "address": { "lines": [\ ""\ ], "country_code": "" }, "identifier": "", "type": "", "identifier_code": "" } }, "swift": { "account_holder": { "legal_name": "", "iban": "", "bban": "", "domestic_account_id": "", "customer_payment_address1": "", "customer_payment_address2": "", "customer_payment_address3": "", "customer_payment_country_code": "" }, "institution": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" }, "intermediary": { "bic": "", "name": "", "bank_address1": "", "bank_address2": "", "bank_address3": "", "bank_country_code": "", "domestic_bank_id": "", "international_bank_id": "" } }, "card": { "first_data_token": { "value": "", "store_id": "" }, "expiry_date": { "month": "", "year": "" }, "postal_code": "", "merchant": { "mid": "" }, "vault_token": { "value": "", "vault_id": "" }, "worldpay_params": { "token_value": "", "uses_merchant_token": true, "accept_header": "", "user_agent_header": "", "shopper_ip": "", "shopper_session_id": "" }, "previous_scheme_tx_id": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "phone_number": "", "user_id": "", "customer_first_name": "", "customer_last_name": "", "six_digit_bin": "", "last_four": "", "customer_dob": { "month": "", "day": "", "year": "" }, "scheme": "", "eight_digit_bin": "", "checkout_token": { "source_id": "" } }, "zengin": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "uk": { "account_holder": { "legal_name": "", "bban": "", "sort_code": "", "account_number": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "institution": { "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "sepa": { "account_holder": { "legal_name": "", "iban": "", "bban": "" }, "institution": { "bic": "", "name": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "" }, "paypal": { "account_holder": { "paypal_id": "", "paypal_pm_id": "" }, "merchant": { "merchant_account_id": "" }, "metadata": { "paypal_correlation_id": "" } }, "ledger_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } }, "external_payment_method": { "payment_method_id": "" }, "pro_account": { "account_id": "", "coinbase_account_id": "", "user_id": "", "currency": "", "portfolio_id": "" }, "rtp": { "account_holder": { "legal_name": "", "identifier": "" }, "institution": { "routing_number": "" } }, "venue": { "name": "" }, "ledger_named_account": { "name": "", "currency": "", "foreign_network": "" }, "custodial_pool": { "name": "", "network": "", "fiat_id": "" }, "apple_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "apple_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "default_account": { "user_uuid": "", "currency": "" }, "remitly": { "account_holder": { "recipient_id": "", "payout_method_type": "" } }, "pro_internal_account": { "user_id": "", "currency": "" }, "dapp_wallet_account": { "user_uuid": "", "network": "", "cohort_id": "", "signing_backend": "", "currency": "" }, "google_pay": { "braintree": { "nonce": "", "correlation_id": "" }, "google_pay": { "nonce": "", "correlation_id": "" }, "user_id": "", "postal_code": "", "customer_name": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "six_digit_bin": "", "last_four": "", "issuing_country": "", "issuing_bank": "", "product_id": "", "scheme": "", "prepaid": "", "debit": "" }, "dapp_wallet_blockchain_address": { "network": "", "address": "", "cohort_id": "", "user_uuid": "", "pool": "" }, "zaakpay_mobikwik": { "phone_number": "" }, "deneb_upi": { "vpa_id": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "bank_account": { "customer_account_type": "", "customer_account_number": "", "customer_routing_number": "", "customer_name": "" }, "identity_contract_call": { "network": "", "address": "" }, "deneb_imps": { "ifsc_code": "", "account_number": "", "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "pan": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" } }, "allocation": { "id": "", "legs": [\ {\ "id": "",\ "movements": [\ {\ "id": "",\ "source_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "destination_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "amount": {\ "amount": "",\ "currency": ""\ }\ }\ ],\ "is_netted": true\ }\ ], "is_netted": true }, "liquidity_pool": { "network": "", "pool": "", "currency": "", "account_id": "", "from_address": "" }, "zengin_v2": { "account_holder": { "legal_name": "", "identifier": "", "type": "" }, "institution": { "bank_code": "", "branch_code": "" } }, "direct_deposit": { "direct_deposit_account": "" }, "sepa_v2": { "account": { "legal_name": "", "iban": "" }, "customer_first_name": "", "customer_last_name": "", "email": "", "phone_number": "", "customer_country": "", "address": { "address1": "", "address2": "", "city": "", "state": "", "postal_code": "", "country": "" }, "supports_open_banking": true }, "zepto": { "account": { "contact_id": "", "bank_account_id": "" } }, "pix_ebanx": { "payment_method_id": "", "user_uuid": "", "deposit": { "transaction_id": "", "account_id": "" }, "withdrawal": { "account_number": "", "account_type": "", "bank_code": "", "branch_number": "", "pix_key": "" } }, "signet": { "signet_wallet_id": "" }, "derivative_settlement": { "account_settlements": [\ {\ "amount": {\ "amount": "",\ "currency": ""\ },\ "source_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "source_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "target_ledger_account": {\ "account_id": "",\ "currency": "",\ "owner": {\ "id": "",\ "uuid": "",\ "user_uuid": "",\ "type": ""\ }\ },\ "target_ledger_named_account": {\ "name": "",\ "currency": "",\ "foreign_network": ""\ },\ "hold_id_to_replace": "",\ "new_hold_id": "",\ "new_hold_amount": {\ "amount": "",\ "currency": ""\ },\ "existing_hold_id": ""\ }\ ], "equity_reset": { "amount": { "amount": "", "currency": "" }, "equity_account": { "account_id": "", "currency": "", "owner": { "id": "", "uuid": "", "user_uuid": "", "type": "" } } } }, "user": { "user_uuid": "" }, "sg_fast": { "account": { "customer_name": "", "account_number": "" }, "institution": { "bank_code": "" } }, "interac": { "pmsvc_id": "", "account": { "account_name": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "intra_bank": { "currency": "", "account_number": "", "routing_number": "", "customer_name": "", "fiat_id": "" }, "cbit": { "cbit_wallet_address": "", "customers_bank_account_id": "" }, "ideal": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sofort": { "currency": "", "iban": "", "bic": "", "bank_name": "", "customer_payment_name": "", "customer_country_code": "" }, "sg_paynow": { "identifier_type": "", "identifier": "", "customer_name": "" }, "checkout_payment_link": { "payment_link_id": "" }, "email_address": { "value": "" }, "phone_number": { "value": "" }, "vendor_payment": { "vendor_name": "", "vendor_payment_id": "" }, "ctn": { "id": "" }, "bancomat_pay": { "customer_name": "", "account": { "phone_number": "" } }, "hot_wallet": { "network": "", "address": "" }, "nova_account": { "network": "", "nova_account_id": "", "pool_name": "", "account_idempotency_key": "" }, "magic_spend_blockchain_address": { "address": "", "destination_tag": "" }, "transfer_pointer": { "idem": "" }, "eft": { "account": { "account_name": "", "account_phone_number": "", "account_email": "", "institution_number": "", "transit_number": "", "account_number": "" } }, "wallace_account": { "wallace_account_id": "", "pool_name": "" }, "manual": { "settlement_bank_name": "", "settlement_account_number": "", "reference": "" }, "argentine_bank_account": { "tax_id": "", "cbu": "" }, "representment": { "currency": "" }, "banking_circle_now": { "iban": "", "currency": "", "customer_payment_name": "" }, "trustly": { "country": "", "iban": "", "account_holder": "", "bank_code": "", "account_number": "", "partial_account_number": "", "bank_name": "", "email": "" }, "blik": { "email": "", "country": "", "account_holder": "" }, "mb_way": {}, "pix": { "account_number": "", "account_type": "", "bank_code": "", "bank_name": "", "branch_number": "", "customer_payment_name": "", "sender_document": "", "pix_key": "" } }, "unit_price": { "target_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "target_to_source": { "amount": { "value": "", "currency": "" }, "scale": 123 }, "source_to_fiat": { "amount": { "value": "", "currency": "" }, "scale": 123 } }, "user_warnings": [\ {\ "id": "",\ "link": {\ "text": "",\ "url": ""\ },\ "context": {\ "details": [\ ""\ ],\ "title": "",\ "link_text": ""\ },\ "code": "",\ "message": ""\ }\ ], "user_reference": "", "source_currency": "", "target_currency": "", "cancellation_reason": { "message": "", "code": "", "error_code": "", "error_cta": "", "error_metadata": { "limit_amount": { "value": "", "currency": "" } }, "title": "" }, "source_id": "", "target_id": "", "subscription_info": { "free_trading_reset_date": "", "used_zero_fee_trading": { "value": "", "currency": "" }, "remaining_free_trading_volume": { "value": "", "currency": "" }, "max_free_trading_volume": { "value": "", "currency": "" }, "has_benefit_cap": true, "applied_subscription_benefit": true, "fee_without_subscription_benefit": { "value": "", "currency": "" }, "payment_method_fee_without_subscription_benefit": { "value": "", "currency": "" } }, "exchange_rate": { "value": "", "currency": "" }, "tax_details": [\ {\ "name": "",\ "amount": {\ "value": "",\ "currency": ""\ }\ }\ ], "trade_incentive_info": { "applied_incentive": true, "user_incentive_id": "", "code_val": "", "ends_at": "", "fee_without_incentive": { "value": "", "currency": "" }, "redeemed": true }, "total_fee_without_tax": { "title": "", "description": "", "amount": { "value": "", "currency": "" }, "label": "", "disclosure": { "title": "", "description": "", "link": { "text": "", "url": "" } }, "waived_details": { "amount": { "value": "", "currency": "" }, "source": "" } }, "fiat_denoted_total": { "value": "", "currency": "" } } } #### Path Parameters [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade#parameter-trade-id) trade\_id string required The ID of the trade to commit. #### Query Parameters [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade#parameter-from-account) from\_account string required The currency of the account to convert from (e.g. USD). [​](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade#parameter-to-account) to\_account string required The currency of the account to convert to (e.g. USDC). #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Create Convert Quote\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/create-convert-quote) [Get API Key Permissions\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/data-api/get-api-key-permissions) Assistant Responses are generated using AI and may contain mistakes. --- # Wallet Management - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Core Concepts Wallet Management [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ##### GET STARTED * [Home](https://docs.cdp.coinbase.com/) * [Quickstart](https://docs.cdp.coinbase.com/get-started/quickstart) * [Use AI Tooling](https://docs.cdp.coinbase.com/get-started/use-ai-tooling) * [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) * Authentication * Demo Apps * CDP Portal ##### WALLETS * [Comparing Our Wallets](https://docs.cdp.coinbase.com/wallet-api/comparing-our-wallets) * Wallet APIv2 * Wallet APIv1 * [Smart Wallet](https://docs.base.org/base-account/overview/what-is-base-account) ##### PAYMENTS * Send & Receive * Onramp & Offramp * x402 ##### SWAPS * Swap APIBeta ##### BASE TOOLS * Paymaster * Appchains * [Onchainkit](https://docs.base.org/onchainkit/getting-started) ##### DATA * [Introduction](https://docs.cdp.coinbase.com/data/introduction/welcome) * Node * Address History * WebhooksAlpha * Smart Contract Events * Verifications ##### AI * AgentKit * [Welcome](https://docs.cdp.coinbase.com/agent-kit/welcome) * Getting Started * Core Concepts * [Agents Actions](https://docs.cdp.coinbase.com/agent-kit/core-concepts/agents-actions) * [Frameworks](https://docs.cdp.coinbase.com/agent-kit/core-concepts/frameworks) * [Integrate LangChain Tools](https://docs.cdp.coinbase.com/agent-kit/core-concepts/integrate-langchain-tools) * [Vercel AI SDK](https://docs.cdp.coinbase.com/agent-kit/core-concepts/vercel-ai-sdk) * [Model Context Protocol](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) * [Wallet Management](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management) * [Prompts and Models](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) * [Architecture Explained](https://docs.cdp.coinbase.com/agent-kit/core-concepts/architecture-explained) * [Hosting Agents](https://docs.cdp.coinbase.com/agent-kit/core-concepts/hosting-agents) * Reference Docs * One-Page Reference * GitHub * Support ##### STAKING * Staking API * Staking Delegation Guides ##### FAUCET * Using Faucets ##### CONSUMER APIS * Coinbase App * Coinbase Wallet * Coinbase Mesh ##### BUSINESS APIS * Coinbase Business * Coinbase Commerce ##### INSTITUTIONAL APIS * [Overview](https://docs.cdp.coinbase.com/institutional-apis/overview) * Coinbase Exchange * Coinbase International Exchange * Coinbase Prime * Coinbase Derivatives On this page * [Wallet Configuration](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management#wallet-configuration) * [Default Operations](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management#default-operations) AgentKit supports multiple wallet providers, with the [CDP Wallet API](https://docs.cdp.coinbase.com/wallet-api/v1/introduction/welcome) being the default implementation. It supports the following operations, alongside compatibility with the full suite of CDP products including Onramp, and Commerce: * [Creating API Wallets](https://docs.cdp.coinbase.com/wallet-api/v1/concepts/wallets) * [Signing transactions](https://docs.cdp.coinbase.com/wallet-api/v1/introduction/onchain-interactions/message-signing) * [Deploying and interacting with tokens](https://docs.cdp.coinbase.com/wallet-api/v1/introduction/onchain-interactions/smart-contract-deployments) * [Invoking smart contracts and querying chain state](https://docs.cdp.coinbase.com/wallet-api/v1/introduction/onchain-interactions/smart-contract-interactions) [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management#wallet-configuration) Wallet Configuration ------------------------------------------------------------------------------------------------------------------------- You can configure AgentKit to use a CDP wallet or a custom wallet provider. * CDP Wallet v2 * CDP Wallet * Viem/EthAccount Wallet * Privy Server Wallet (EVM/Solana) * Solana Keypair Wallet The [CDP Wallet v2 API](https://docs.cdp.coinbase.com/wallet-api/v2/introduction/welcome) is the recommended wallet provider for AgentKit. It supports both EVM and Solana chains, seamlessly and securely handles private keys, and is compatible with viem. * Typescript * Python Copy Ask AI import { AgentKit, CdpV2WalletProvider, CdpV2EvmWalletProvider, // for evm CdpV2SolanaWalletProvider, // for solana } from "@coinbase/agentkit"; // Configure CDP Wallet Provider const cdpWalletConfig = { apiKeyId: process.env.CDP_API_KEY_ID, // from https://portal.cdp.coinbase.com , see v2 wallet quickstart for more details apiKeySecret: process.env.CDP_API_KEY_SECRET, walletSecret: process.env.CDP_WALLET_SECRET, idempotencyKey: process.env.IDEMPOTENCY_KEY, // optional, used for account creation address: process.env.ADDRESS as `0x${string}` | undefined, // optional, used for existing account networkId: process.env.NETWORK_ID, // e.g. "base", "base-sepolia", "solana" }; const walletProvider = await CdpV2WalletProvider.configureWithWallet(cdpWalletConfig); // ... // Initialize AgentKit const agentkit = await AgentKit.from({ walletProvider, actionProviders: [], }); [​](https://docs.cdp.coinbase.com/agent-kit/core-concepts/wallet-management#default-operations) Default Operations --------------------------------------------------------------------------------------------------------------------- By default, AgentKit supports the following basic wallet operations: * `get_wallet_details` - Get details about the Wallet, like the address * `transfer` - Transfer assets between addresses * `get_balance` - Get the balance of an asset You can add additional actions or action providers upon agent instantiation. Was this page helpful? YesNo [Model Context Protocol (MCP) AgentKit Extension\ \ Previous](https://docs.cdp.coinbase.com/agent-kit/core-concepts/model-context-protocol) [Prompts and Models\ \ Next](https://docs.cdp.coinbase.com/agent-kit/core-concepts/prompts-and-models) Assistant Responses are generated using AI and may contain mistakes. --- # List Futures Positions - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Futures List Futures Positions [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * Fees * Futures * [DEL\ \ Cancel Pending Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) * [GET\ \ Get Current Margin Window](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) * [GET\ \ Get Futures Balance Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary) * [GET\ \ Get Futures Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) * [GET\ \ Get Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting) * [GET\ \ List Futures Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) * [GET\ \ List Futures Sweeps](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps) * [POST\ \ Schedule Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep) * [POST\ \ Set Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings) * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public List Futures Positions cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/positions 200 default Copy Ask AI { "positions": [\ {\ "product_id": "",\ "expiration_time": "",\ "side": "",\ "number_of_contracts": "",\ "current_price": "",\ "avg_entry_price": "",\ "unrealized_pnl": "",\ "daily_realized_pnl": ""\ }\ ] } GET / api / v3 / brokerage / cfm / positions Try it List Futures Positions cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/positions 200 default Copy Ask AI { "positions": [\ {\ "product_id": "",\ "expiration_time": "",\ "side": "",\ "number_of_contracts": "",\ "current_price": "",\ "avg_entry_price": "",\ "unrealized_pnl": "",\ "daily_realized_pnl": ""\ }\ ] } #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Get Intraday Margin Setting\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting) [List Futures Sweeps\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps) Assistant Responses are generated using AI and may contain mistakes. --- # Get Intraday Margin Setting - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Futures Get Intraday Margin Setting [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * Fees * Futures * [DEL\ \ Cancel Pending Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) * [GET\ \ Get Current Margin Window](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) * [GET\ \ Get Futures Balance Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary) * [GET\ \ Get Futures Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) * [GET\ \ Get Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting) * [GET\ \ List Futures Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) * [GET\ \ List Futures Sweeps](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps) * [POST\ \ Schedule Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep) * [POST\ \ Set Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings) * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public Get Intraday Margin Setting cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/intraday/margin_setting 200 default Copy Ask AI { "setting": "" } GET / api / v3 / brokerage / cfm / intraday / margin\_setting Try it Get Intraday Margin Setting cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/intraday/margin_setting 200 default Copy Ask AI { "setting": "" } #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [Get Futures Position\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) [List Futures Positions\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) Assistant Responses are generated using AI and may contain mistakes. --- # List Futures Sweeps - Coinbase [Coinbase home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coinbase-prod/logos/wordmark-dark.svg)](https://docs.cdp.coinbase.com/) Search... ⌘KAsk AI Search... Navigation Futures List Futures Sweeps [Docs](https://docs.cdp.coinbase.com/) [API Reference](https://docs.cdp.coinbase.com/api-reference/v2/introduction) [SDKs](https://docs.cdp.coinbase.com/sdks) ![https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg](https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg) Coinbase Advanced Trade API ##### REST API * [Introduction](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction) * Accounts * Convert * Data API * Fees * Futures * [DEL\ \ Cancel Pending Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep) * [GET\ \ Get Current Margin Window](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window) * [GET\ \ Get Futures Balance Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary) * [GET\ \ Get Futures Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position) * [GET\ \ Get Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting) * [GET\ \ List Futures Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) * [GET\ \ List Futures Sweeps](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps) * [POST\ \ Schedule Futures Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep) * [POST\ \ Set Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings) * Orders * Payment Methods * Perpetuals * Portfolios * Products * Public List Futures Sweeps cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/sweeps 200 default Copy Ask AI { "sweeps": [\ {\ "id": "",\ "requested_amount": {\ "value": "",\ "currency": ""\ },\ "should_sweep_all": true,\ "status": "",\ "scheduled_time": ""\ }\ ] } GET / api / v3 / brokerage / cfm / sweeps Try it List Futures Sweeps cURL Copy Ask AI curl --request GET \ --url https://api.coinbase.com/api/v3/brokerage/cfm/sweeps 200 default Copy Ask AI { "sweeps": [\ {\ "id": "",\ "requested_amount": {\ "value": "",\ "currency": ""\ },\ "should_sweep_all": true,\ "status": "",\ "scheduled_time": ""\ }\ ] } #### Response 200 200default application/json application/jsontext/event-stream A successful response. The response is of type `object`. Was this page helpful? YesNo [List Futures Positions\ \ Previous](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions) [Schedule Futures Sweep\ \ Next](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep) Assistant Responses are generated using AI and may contain mistakes. ---