POST https://api.cryptohopper.com/v1/hopper/{id}/position/sync

Adds an open position for a coin balance the hopper does not track yet, using the amount and rate you send, and records a matching buy trade.

OAuth scope: read manage About scopes

currency, amount and rate are all required. Not available for exchange arbitrage, market maker, copy and grid bots.

Example request

curl -X POST "https://api.cryptohopper.com/v1/hopper/HOPPER_ID/position/sync" \
  -H "access-token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"currency":"ETH","amount":0.25,"rate":3120.45}'

Parameters

Headers

NameTypeRequiredDescription
access-token string Required The OAuth access token of the user.

Path parameters

NameTypeRequiredDescription
id string Required Hopper ID.

Request body

JSON, model PositionSyncPost

FieldTypeRequiredDescription
currencystringOptional
ratenumberOptional
amountnumberOptional

Response

Example response (illustrative values)

{
    "data": "Position has been synced."
}

Status codes: 200. Errors return JSON with status, error and message. See How the API works for response codes and rate limits.