DEVELOPERSAPI Reference
Every endpoint of the Cryptohopper REST API, grouped by resource. Each page lists the required OAuth scope, the parameters and the request body, request examples in cURL, JavaScript, Python and PHP, and an example response.
- Base URL
https://api.cryptohopper.com/v1- Token header
access-token- Format
- JSON
- OpenAPI
- Swagger 2.0 file
Hoppers
Create, update and delete hoppers (trading bots), switch trading on or off, manage paper trading balances, and read stats, assets and the output log.
-
GET
Get hoppers of users
/hopper -
POST
Create a new hopper
/hopper -
PATCH
Update mobile notifications
/hopper/receivingmobilenotifications -
GET
Retrieve hopper
/hopper/{id} -
PATCH
Update hopper
/hopper/{id} -
DELETE
Delete hopper
/hopper/{id} -
GET
Get the latest hopper activity
/hopper/{id}/activity -
GET
Get assets
/hopper/{id}/assets -
POST
Change bot type
/hopper/{id}/changebot -
POST
Change hopper image
/hopper/{id}/changeimage -
PATCH
Disable hopper
/hopper/{id}/disable -
PATCH
Disable buying
/hopper/{id}/disable/buying -
PATCH
Disable papertrading
/hopper/{id}/disable/papertrading -
PATCH
Disable selling
/hopper/{id}/disable/selling -
PATCH
Enable hopper
/hopper/{id}/enable -
PATCH
Enable buying
/hopper/{id}/enable/buying -
PATCH
Enable papertrading
/hopper/{id}/enable/papertrading -
PATCH
Enable selling
/hopper/{id}/enable/selling -
DELETE
Disconnect a hopper from Fast API
/hopper/{id}/fastapi -
GET
Get IP addresses to whitelist
/hopper/{id}/ipwhitelist -
GET
Get most traded currencies
/hopper/{id}/mosttraded -
GET
Get output
/hopper/{id}/output -
GET
Activate panic mode
/hopper/{id}/panicbutton -
DELETE
Deactivate panic mode
/hopper/{id}/panicbutton -
POST
Deposit paper trading
/hopper/{id}/papertrading/deposit -
PATCH
Reset paper trading balance
/hopper/{id}/papertrading/reset -
POST
Withdraw assets from paper trader
/hopper/{id}/papertrading/withdraw -
PATCH
Rebalance a portfolio bot
/hopper/{id}/rebalance -
POST
Reset hopper
/hopper/{id}/reset -
PATCH
Set default hopper
/hopper/{id}/setdefaulthopper -
GET
Get start balance
/hopper/{id}/startbalance -
POST
Set start balance
/hopper/{id}/startbalance -
GET
Get stats
/hopper/{id}/stats -
GET
Get stats from dashboard
/hopper/{id}/stats/dashboard -
POST
Reset stats
/hopper/{id}/stats/reset -
GET
Stop a copy bot
/hopper/{id}/stop -
GET
Get subscription
/hopper/{id}/subscription -
GET
Get current targets
/hopper/{id}/targets -
POST
Save template
/hopper/{id}/template/save -
GET
Run the troubleshooter
/hopper/{id}/troubleshooter
Positions
The positions of a hopper: sell, hold, release, DCA, split, merge and short positions, and reserved balances.
-
GET
Get positions
/hopper/{id}/position -
POST
DCA positions
/hopper/{id}/position/dca -
POST
Block or unblock DCA for a coin
/hopper/{id}/position/dca/block -
POST
Reset DCA for a coin
/hopper/{id}/position/dca/reset -
POST
Place a DCA order for a position
/hopper/{id}/position/dca/{position_id} -
POST
Block or unblock DCA for a position
/hopper/{id}/position/dca/{position_id}/block -
POST
Reset DCA for a position
/hopper/{id}/position/dca/{position_id}/reset -
GET
Get positions with hold
/hopper/{id}/position/hold -
POST
Hold positions
/hopper/{id}/position/hold -
POST
Hold position
/hopper/{id}/position/hold/{position_id} -
POST
Merge positions
/hopper/{id}/position/merge -
POST
Move positions to reserved
/hopper/{id}/position/movetoreserved -
POST
Move position to reserved
/hopper/{id}/position/movetoreserved/{position_id} -
GET
Get open positions without hold
/hopper/{id}/position/release -
POST
Release positions
/hopper/{id}/position/release -
POST
Release position
/hopper/{id}/position/release/{position_id} -
DELETE
Remove positions
/hopper/{id}/position/remove -
DELETE
Remove position
/hopper/{id}/position/remove/{position_id} -
POST
Sell positions
/hopper/{id}/position/sell -
POST
Sell position
/hopper/{id}/position/sell/{position_id} -
POST
Change settings of open positions
/hopper/{id}/position/setpositionsetting -
POST
Change settings of short positions
/hopper/{id}/position/setshortsetting -
POST
Set take profit
/hopper/{id}/position/settakeprofit -
POST
Open short positions
/hopper/{id}/position/short -
POST
Open a short position
/hopper/{id}/position/short/{position_id} -
POST
Split positions
/hopper/{id}/position/split -
POST
Split position
/hopper/{id}/position/split/{position_id} -
GET
Get unsynced positions
/hopper/{id}/position/sync -
POST
Sync a position
/hopper/{id}/position/sync -
GET
Get position
/hopper/{id}/position/{position_id} -
DELETE
Delete position
/hopper/{id}/position/{position_id} -
POST
Update position
/hopper/{id}/position/{position_id}/update -
GET
Get reserved positions
/hopper/{id}/reserved -
PATCH
Move reserved positions to open positions
/hopper/{id}/reserved/movetopositions -
DELETE
Release reserved positions
/hopper/{id}/reserved/release -
GET
Get a reserved position
/hopper/{id}/reserved/{reserved_id} -
PATCH
Move a reserved position to open positions
/hopper/{id}/reserved/{reserved_id}/movetopositions -
DELETE
Release a reserved position
/hopper/{id}/reserved/{reserved_id}/release -
GET
Get shorts
/hopper/{id}/short -
POST
Close short positions
/hopper/{id}/short/close -
POST
Close short position
/hopper/{id}/short/close/{position_id} -
POST
Hold short positions
/hopper/{id}/short/hold -
POST
Hold short position
/hopper/{id}/short/hold/{position_id} -
POST
Release short positions
/hopper/{id}/short/release -
POST
Release short position
/hopper/{id}/short/release/{position_id} -
DELETE
Delete short positions
/hopper/{id}/short/remove -
DELETE
Delete short position
/hopper/{id}/short/remove/{position_id} -
GET
Get a short position
/hopper/{id}/short/{short_id} -
POST
Update short position
/hopper/{id}/short/{short_id}/update
Orders
The open orders of a hopper: list, place and cancel orders.
-
GET
Get open orders
/hopper/{id}/order -
POST
Create new order
/hopper/{id}/order -
DELETE
Remove open orders
/hopper/{id}/order -
DELETE
Cancel all open orders
/hopper/{id}/order/all -
GET
Get open order
/hopper/{id}/order/{order_id} -
DELETE
Remove an open order
/hopper/{id}/order/{order_id} -
DELETE
Cancel order
/hopper/{id}/order/{order_id}/cancel -
DELETE
Cancel TSB order
/hopper/{id}/order/{order_id}/tsb
Trade history
The completed trades of a hopper.
Bot config
The base config of a hopper and its config pools.
-
GET
Get baseconfig
/hopper/{id}/config -
PATCH
Update baseconfig
/hopper/{id}/config -
GET
Get config pools
/hopper/{id}/config/pool -
POST
Create a config pool
/hopper/{id}/config/pool -
GET
Get config pool
/hopper/{id}/config/pool/{pool_id} -
PATCH
Update config pool
/hopper/{id}/config/pool/{pool_id} -
DELETE
Delete a config pool
/hopper/{id}/config/pool/{pool_id}
Signals
The signals a hopper follows: subscribe, unsubscribe and configure signals.
-
GET
Get signals in hopper
/hopper/{id}/signal -
GET
Get last signal
/hopper/{id}/signal/last -
GET
Get signal by id
/hopper/{id}/signal/{signal_id} -
POST
Subscribe to signal
/hopper/{id}/signal/{signal_id} -
PATCH
Update config of signal
/hopper/{id}/signal/{signal_id} -
DELETE
Unsubscribe from signal
/hopper/{id}/signal/{signal_id}
Triggers
The triggers of a hopper and their history.
-
GET
Get triggers
/hopper/{id}/trigger -
POST
Create a trigger
/hopper/{id}/trigger -
GET
Get trigger
/hopper/{id}/trigger/{trigger_id} -
PATCH
Update trigger
/hopper/{id}/trigger/{trigger_id} -
DELETE
Delete trigger
/hopper/{id}/trigger/{trigger_id} -
GET
Get trigger options
/hopper/{id}/triggerconfigs -
GET
Get trigger history
/hopper/{id}/triggerhistory
Arbitrage
Exchange and market arbitrage hoppers: backlog, results, trade history and cancelling arbitrage.
-
GET
Get positions in backlog
/hopper/{id}/arbitrage/backlog -
DELETE
Delete backlog positions
/hopper/{id}/arbitrage/backlog -
GET
Get backlog item
/hopper/{id}/arbitrage/backlog/{backlog_id} -
DELETE
Delete a backlog position
/hopper/{id}/arbitrage/backlog/{backlog_id} -
POST
Cancel arbitrage
/hopper/{id}/arbitrage/cancel -
GET
Get open exchange arbitrages
/hopper/{id}/arbitrage/exchange -
POST
Cancel arbitrage
/hopper/{id}/arbitrage/exchange/cancel -
POST
Cancel arbitrage
/hopper/{id}/arbitrage/exchange/cancel/{arbitrage_id} -
GET
Get trade history for arbitrage hopper
/hopper/{id}/arbitrage/exchange/history/{start}/{limit} -
GET
Get exchange arbitrage scan results
/hopper/{id}/arbitrage/exchange/results -
GET
Get open market arbitrages
/hopper/{id}/arbitrage/market -
POST
Cancel market arbitrage
/hopper/{id}/arbitrage/market/cancel -
POST
Cancel market arbitrage
/hopper/{id}/arbitrage/market/cancel/{arbitrage_id} -
GET
Get trade history for market arbitrage hopper
/hopper/{id}/arbitrage/market/history/{start}/{limit} -
GET
Get market arbitrage scan results
/hopper/{id}/arbitrage/market/results -
GET
Get total assets from arbitrage hopper
/hopper/{id}/arbitrage/total -
DELETE
Reset total assets from arbitrage hopper
/hopper/{id}/arbitrage/total
Market maker
Market maker hoppers: active market makers, backlog, trade history and trend.
-
GET
Get active market makers
/hopper/{id}/marketmaker -
GET
Get positions in backlog
/hopper/{id}/marketmaker/backlog -
DELETE
Delete backlog positions
/hopper/{id}/marketmaker/backlog -
GET
Get backlog item
/hopper/{id}/marketmaker/backlog/{backlog_id} -
DELETE
Delete a backlog position
/hopper/{id}/marketmaker/backlog/{backlog_id} -
POST
Cancel market maker
/hopper/{id}/marketmaker/cancel -
POST
Cancel market maker
/hopper/{id}/marketmaker/cancel/{marketmaker_id} -
GET
Get trade history for market maker hopper
/hopper/{id}/marketmaker/history/{start}/{limit} -
GET
Get trend for market makers
/hopper/{id}/marketmaker/trend -
POST
Set trend for market maker
/hopper/{id}/marketmaker/trend -
DELETE
Remove the manual trend
/hopper/{id}/marketmaker/trend
Backtesting
Run and manage backtests, with their notes and versions.
-
GET
List backtests
/backtest -
POST
Start a backtest
/backtest -
GET
Get backtest limits
/backtest/limits -
GET
Get a backtest
/backtest/{id} -
DELETE
Delete a backtest
/backtest/{id} -
GET
Cancel a backtest
/backtest/{id}/cancel -
GET
Get backtest notes
/backtest/{id}/notes -
POST
Add a note to a backtest
/backtest/{id}/notes -
PATCH
Update a backtest note
/backtest/{id}/notes/{note_id} -
DELETE
Delete a backtest note
/backtest/{id}/notes/{note_id} -
POST
Restart a backtest
/backtest/{id}/restart -
GET
List backtest versions
/backtest/{id}/versions -
DELETE
Delete all backtest versions
/backtest/{id}/versions -
GET
Get a backtest version
/backtest/{id}/versions/{version_id} -
DELETE
Delete a backtest version
/backtest/{id}/versions/{version_id} -
GET
List strategy backtests
/hopper/{id}/backtest -
POST
Start a strategy backtest
/hopper/{id}/backtest -
GET
List strategy backtests by page
/hopper/{id}/backtest/{start}/{limit}
Templates
Your config templates and the templates you got from the marketplace.
-
GET
Get templates
/template -
GET
Get basic templates
/template/basic -
GET
Get basic templates for an exchange
/template/basic/{exchange} -
GET
Get market templates
/template/market -
GET
Get market template
/template/market/{template_id} -
DELETE
Delete market template
/template/market/{template_id} -
POST
Load market template
/template/market/{template_id}/load/{hopper_id} -
GET
Get template
/template/{template_id} -
DELETE
Delete template
/template/{template_id} -
POST
Change the image of a template
/template/{template_id}/changeimage -
POST
Load template
/template/{template_id}/load/{hopper_id}
Strategies
Your trading strategies and the strategies you got from the marketplace.
-
GET
Get strategies
/strategy -
POST
Create strategy
/strategy -
GET
Get market strategies
/strategy/market -
GET
Get market strategy
/strategy/market/{strategy_id} -
DELETE
Delete market strategy
/strategy/market/{strategy_id} -
GET
Get AI models
/strategy/models -
GET
Get strategy
/strategy/{strategy_id} -
PATCH
Update strategy
/strategy/{strategy_id} -
DELETE
Delete strategy
/strategy/{strategy_id} -
POST
Generate a strategy with AI
/strategy/{strategy_id}/aigenerate -
POST
Change the image of a strategy
/strategy/{strategy_id}/changeimage
Marketplace
Signals, strategies, templates, copy bots and gift cards in the Cryptohopper marketplace, with their reviews.
-
GET
List copy bots
/market/copybots -
GET
Get a copy bot
/market/copybots/{copybot_id} -
GET
Get copy bot reviews
/market/copybots/{copybot_id}/review -
POST
Post a copy bot review
/market/copybots/{copybot_id}/review -
GET
Get a copy bot review
/market/copybots/{copybot_id}/review/{review_id} -
POST
Download a free marketplace item
/market/downloaditem -
GET
Get marketplace gift cards
/market/giftcards -
POST
Redeem a gift card
/market/giftcards/activate -
GET
Get gift card images
/market/giftcards/images -
GET
Get unredeemed gift cards
/market/giftcards/orders -
GET
Get unpaid gift card orders
/market/giftcards/orders/purchased -
GET
Get redeemed gift cards
/market/giftcards/orders/used -
GET
Get a gift card order
/market/giftcards/orders/{order_id} -
DELETE
Delete a gift card order
/market/giftcards/orders/{order_id} -
GET
Get your custom gift cards
/market/giftcards/user -
POST
Create a custom gift card
/market/giftcards/user -
POST
Check a gift card code
/market/giftcards/validate -
GET
Get a gift card
/market/giftcards/{giftcard_id} -
DELETE
Delete a custom gift card
/market/giftcards/{giftcard_id} -
GET
Get the marketplace homepage
/market/homepage -
GET
List portfolios
/market/portfolios -
GET
Get a portfolio
/market/portfolios/{portfolio_id} -
GET
Get portfolio reviews
/market/portfolios/{portfolio_id}/review -
GET
Get review
/market/review/{review_id} -
PATCH
Update a market review
/market/review/{review_id} -
DELETE
Delete a review
/market/review/{review_id} -
POST
Reply to a market review
/market/review/{review_id}/reply -
POST
Save a market review
/market/savereview -
GET
Get a marketplace seller
/market/seller/{seller_id} -
GET
Get available signals
/market/signals -
GET
Get signal
/market/signals/{signal_id} -
GET
Get signal chart data
/market/signals/{signal_id}/chartdata -
GET
Get signal profit distribution
/market/signals/{signal_id}/distribution -
GET
Get recent signals of a signal provider
/market/signals/{signal_id}/performance -
GET
Get signal reviews
/market/signals/{signal_id}/review -
POST
Post a signal review
/market/signals/{signal_id}/review -
GET
Get a signal review
/market/signals/{signal_id}/review/{review_id} -
GET
Get signal stats
/market/signals/{signal_id}/stats -
GET
Get available strategies
/market/strategies -
GET
Get a strategy
/market/strategies/{strategy_id} -
GET
Get strategy reviews
/market/strategies/{strategy_id}/review -
POST
Post a strategy review
/market/strategies/{strategy_id}/review -
GET
Get a strategy review
/market/strategies/{strategy_id}/review/{review_id} -
GET
Get available templates
/market/templates -
GET
Get a template
/market/templates/{template_id} -
GET
Get template reviews
/market/templates/{template_id}/review -
POST
Post a template review
/market/templates/{template_id}/review -
GET
Get a template review
/market/templates/{template_id}/review/{review_id}
Exchanges
The exchanges on Cryptohopper: markets, currencies, tickers, candles, orderbooks and precision.
-
GET
Get available exchanges
/exchange -
GET
List currencies by market cap
/exchange/currencies -
GET
Get market data for a currency
/exchange/currencies/{currency} -
GET
Get details for each exchange
/exchange/details -
GET
Get rates for forex pairs
/exchange/forex-rates -
GET
Get market cap overview
/exchange/marketcap -
GET
Get market cap details for a currency
/exchange/marketcap/{currency} -
GET
Get market data portal keys
/exchange/portal -
GET
Get portal market maps for all exchanges
/exchange/portal/map -
GET
Get exchanges not on the market data portal
/exchange/sluis -
GET
Get base currencies from exchange
/exchange/{exchange}/basecurrencies -
GET
Check base currency
/exchange/{exchange}/basecurrencies/{base_currency} -
GET
Get candles from exchange
/exchange/{exchange}/candle/{pair}/{time-frame}/{start-date}/{end-date} -
GET
Get available currencies
/exchange/{exchange}/currencies -
GET
Get precision for currencies
/exchange/{exchange}/currencies/decimals -
GET
Get a single currency
/exchange/{exchange}/currency -
GET
Get precision for a currency
/exchange/{exchange}/currency/{currency}/decimals -
GET
Get trading pair
/exchange/{exchange}/getmarket -
GET
Get IP addresses to whitelist
/exchange/{exchange}/ipwhitelist -
GET
Get available markets
/exchange/{exchange}/markets -
GET
Get price and amount decimals
/exchange/{exchange}/markets/{market}/decimals -
GET
Get portal market map for an exchange
/exchange/{exchange}/portal/pairs -
GET
Get all tickers
/exchange/{exchange}/ticker -
GET
Get market ticker
/exchange/{exchange}/ticker/{pair} -
GET
Get tickers
/exchange/{exchange}/tickers -
GET
Get deposit and withdrawal fees
/exchange/{exchange}/withdrawalfees -
GET
Get orderbook
/exchange/{exchange}/{pair}/orderbook/{depth}
Users
The user's profile, email, password, notifications, credits and purchases.
-
GET
Get user profile
/user -
PATCH
Update user profile
/user -
DELETE
Deactivate the user account
/user -
GET
List Ask AI sections
/user/askai -
POST
Ask AI a question
/user/askai -
POST
Start or resume an Ask AI session
/user/askai/new -
POST
Vote on an Ask AI answer
/user/askai/vote -
GET
Get credits
/user/credits -
GET
Get email
/user/email -
POST
Change email
/user/email -
POST
Enable mobile push notifications
/user/enableallmobilepushnotifications -
GET
Get user id
/user/id -
GET
Get Intercom settings
/user/intercomsettings -
GET
Get mobile push notification settings
/user/mobilepushnotifications -
POST
Update mobile push notification settings
/user/mobilepushnotifications -
GET
Get mobile push notification settings for a device
/user/mobilepushnotifications/{player_id} -
GET
Get user notifications
/user/notifications -
POST
Change password
/user/password -
GET
Get user purchases
/user/purchases -
POST
Register user
/user/register -
GET
Check if a two-factor reset is required
/user/require2fareset -
GET
Check if a password reset is required
/user/requirepasswordreset -
POST
Resend activation
/user/resendactivation -
POST
Request a password reset
/user/resetpassword -
PATCH
Set a new password with a reset code
/user/resetpassword -
GET
Get user transactions
/user/transactions -
GET
Get user metadata
/user/usermetadata -
PATCH
Enable mobile notifications in user metadata
/user/usermetadata -
GET
Validate a two-factor code
/user/validatetwofactor
Subscriptions
Subscription plans and the user's subscriptions.
-
GET
Get subscriptions
/subscription -
POST
Assign subscription
/subscription/assign -
GET
Get credit balance
/subscription/credits -
POST
Order a subscription
/subscription/order -
GET
Get subscription plans
/subscription/plans -
GET
Get a subscription plan
/subscription/plans/{plan_id} -
POST
Remap subscriptions
/subscription/remap -
GET
Get a subscription
/subscription/{subscription_id} -
PATCH
Stop a subscription
/subscription/{subscription_id} -
GET
Get the bot of a subscription
/subscription/{subscription_id}/hopper
Webhooks
Register or remove the webhook of your app.
AI
AI results, AI models and AI credits.
-
GET
List your AIs
/ai -
GET
Get your AI credit balance
/ai/credits -
GET
List your AI credit invoices
/ai/credits/invoices -
GET
List your AI credit transactions
/ai/credits/transactions -
GET
List the available AI models
/ai/models -
GET
Get an AI
/ai/{ai_id} -
GET
Get the language model results of an AI
/ai/{ai_id}/airesults
Tournaments
Trading tournaments: join, leaderboards, stats and trades.
-
GET
List tournaments
/tournaments -
GET
List the tournaments you joined
/tournaments/active -
GET
Get the all time tournament leaderboard
/tournaments/leaderboard -
GET
Get the tournament leaderboard of a year
/tournaments/leaderboard/{year} -
POST
Search tournaments
/tournaments/search -
GET
Get a tournament
/tournaments/{tournament_id} -
GET
Get the activity feed of a tournament
/tournaments/{tournament_id}/activity -
POST
Join a tournament
/tournaments/{tournament_id}/join -
DELETE
Leave a tournament
/tournaments/{tournament_id}/join -
GET
Get the leaderboard of a tournament
/tournaments/{tournament_id}/leaderboard -
GET
Get the statistics of a tournament
/tournaments/{tournament_id}/stats -
GET
Get your trades in a tournament
/tournaments/{tournament_id}/trades
Devices
Authorized devices of the user.
Apps
App integrations such as the TradingView webhook.
Platform
Platform data: bot types, countries, languages and blog posts.
Social
Posts, comments, likes, profiles, followers and messages.
/social/alias/social/feed/social/feed/{start}/{end}/social/messages/social/messages/{conversation_id}/social/notifications/social/notifications/{start}/{end}/social/post/social/post/{id}/social/post/{id}/social/post/{id}/comment/social/post/{id}/comment/social/post/{id}/comment/{comment_id}/social/post/{id}/comment/{comment_id}/social/post/{id}/comment/{comment_id}/like/social/post/{id}/comment/{comment_id}/like/social/post/{id}/like/social/post/{id}/like/social/post/{id}/pin/social/post/{id}/repost/social/post/{id}/repost/social/profile/{id}/social/profile/{id}/social/profile/{id}/feed/social/profile/{id}/follow/social/profile/{id}/follow/social/profile/{id}/followers/social/profile/{id}/following/social/search/social/whotofollow