- Home
- MCP servers
- Bithumb
Bithumb
- javascript
0
GitHub Stars
javascript
Language
7 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"zereight-bithumb-mcp": {
"command": "npx",
"args": [
"-y",
"@zereight/bithumb-mcp@latest"
],
"env": {
"BITHUMB_API_KEY": "YOUR_BITHUMB_API_KEY",
"BITHUMB_SECRET_KEY": "YOUR_BITHUMB_SECRET_KEY"
}
}
}
}You can interact with the Bithumb API through this MCP server to fetch cryptocurrency data, manage assets, and perform trading-related actions. It acts as a bridge between your MCP client and Bithumb, exposing a set of endpoints (tools) you can call to retrieve market data, balances, orders, and more. This guide walks you through installing, configuring, and using the server in your MCP setup.
How to use
Use the MCP server with your MCP client (Claude, Roo Code, Cline, or similar) by configuring a local or remote server connection and then calling the available tools. You can fetch ticker data, order books, transaction history, balances, deposit addresses, and place or cancel orders. All interactions are performed through the provided tools, each taking clearly defined inputs and returning JSON strings.
How to install
Prerequisites: you need Node.js and npm installed on your system to run the MCP server commands.
# Step 1: Install the MCP server locally using the given command
npx -y @zereight/bithumb-mcp@latest
# Step 2: If you prefer a client-based setup, you can bootstrap via the MCP settings file (example shown in the configuration section)
Additional sections
Configuration, security, and usage notes help you operate the Bithumb MCP Server effectively. Keep your API keys secure and rotate them as needed. The MCP server expects you to provide the required credentials to access Bithumb APIs and to supply the necessary inputs for each tool.
Configuration and startup details
Configure your MCP client to connect to the Bithumb MCP Server using a local stdio setup. The following example shows how to define the MCP server in your client settings (e.g., mcp_settings.json). This config uses npx to run the MCP package and passes the latest version as an argument.
{
"mcpServers": {
"bithumb-mcp": {
"command": "npx",
"args": [
"-y",
"@zereight/bithumb-mcp@latest"
],
"env": {
"BITHUMB_API_KEY": "YOUR_BITHUMB_API_KEY",
"BITHUMB_SECRET_KEY": "YOUR_BITHUMB_SECRET_KEY"
},
"disabled": false
}
}
}
Environment and run-time details
Before running the server, you must set the following environment variables with your Bithumb credentials.
BITHUMB_API_KEY=YOUR_BITHUMB_API_KEY
BITHUMB_SECRET_KEY=YOUR_BITHUMB_SECRET_KEY
Security notes
Treat API keys as secrets. Do not commit them to version control. Use separate keys for development and production environments and rotate them periodically. Limit the scope of keys to the minimum permissions required by your use cases.
Troubleshooting tips
If you encounter authentication or API access issues, verify that your Bithumb API key and secret key are correct and that they have the necessary permissions. Ensure environment variables are exported in the shell or included in your MCP client configuration before starting the server.
Examples and workflows
Typical workflows include querying ticker data, retrieving order books, checking balances, placing limit or market orders, and managing withdrawals. Use the corresponding tools to perform each action, providing the required inputs such as coin codes, order IDs, and quantities.
Available tools
get_ticker
Fetches cryptocurrency ticker information. Inputs: coinCode (string, required). Returns: Ticker information (JSON string).
get_orderbook
Fetches order book information. Inputs: coinCode (string, required). Returns: Order book details (JSON string).
get_transaction_history
Fetches recent transaction history. Inputs: coinCode (string, required). Returns: Transaction history (JSON string).
get_assets_status
Fetches asset deposit/withdrawal status. Inputs: orderCurrency (string, required). Returns: Deposit/withdrawal status (JSON string).
get_candlestick
Fetches candlestick data. Inputs: orderCurrency (string, required); paymentCurrency (string, required); chartIntervals (string, required). Returns: Candlestick data (JSON string).
post_account
Fetches member account information and fees. Inputs: coinCode (string, required). Returns: Account information (JSON string).
get_balance
Fetches account balance. Inputs: coinCode (string, optional). Returns: Balance information (JSON string).
post_wallet_address
Fetches member's coin deposit wallet address. Inputs: coinCode (string, optional). Returns: Wallet address (JSON string).
post_ticker_user
Fetches member's recent virtual asset transaction information. Inputs: orderCurrency (string, required). Returns: Transaction information (JSON string).
post_orders
Fetches member's order details. Inputs: order_currency (string, required); orderId (string, optional); type (string, optional); count (number, optional); after (number, optional). Returns: Order details (JSON string).
post_order_detail
Fetches details of a specific member order. Inputs: orderId (string, required); orderCurrency (string, required). Returns: Order details (JSON string).
post_user_transactions
Fetches member's transaction completion history. Inputs: searchGb (number, required); orderCurrency (string, required); offset (number, optional); count (number, optional). Returns: Transaction history (JSON string).
post_place
Places a limit order (buy/sell). Inputs: orderCurrency (string, required); units (number, required); price (number, required); type (string, required). Returns: Order placement confirmation (JSON string).
post_cancel
Cancels an order. Inputs: type (string, required); orderId (string, required); orderCurrency (string, required). Returns: Cancellation confirmation (JSON string).
post_market_buy
Places a market buy order. Inputs: units (number, required); orderCurrency (string, required). Returns: Order placement confirmation (JSON string).
post_market_sell
Places a market sell order. Inputs: units (number, required); orderCurrency (string, required). Returns: Order placement confirmation (JSON string).
post_withdrawal_coin
Requests a coin withdrawal. Inputs: units (number, required); address (string, required); currency (string, optional); destination (string, optional). Returns: Withdrawal request confirmation (JSON string).
post_withdrawal_krw
Requests a KRW withdrawal (Deprecated by Bithumb). Inputs: bank (string, required); account (string, required); price (number, required). Returns: Withdrawal request confirmation (JSON string).