POST

Cover all short margin positions

Transfers the exact amount to cover all short margin positions for the specified account.

Path Params

accountId string required

The ID of the account

Body Params

ONE OF

currencies array of strings

all boolean

Responses

200

Margin positions cover response

Response Body

object

balances array of objects
balances object
- currency string
  
  Currency symbol
- quantity string
  
  Net position after the position transfer
- balanceValue object
  
  Returns the value of the margin position. Has 2 fields denoting the currency used and the actual value.
  balanceValue object
  - quantity string decimal required
    
    The specified quantity.
  - currency string required
    
    The specified quantity currency.

400

Bad request - Invalid parameters

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

401

Unauthorized - Invalid or missing authentication

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

403

Forbidden - Insufficient permissions

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

422

Unprocessable Entity - JSON payload is improperly formatted

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

429

Too Many Requests - Rate limit exceeded

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

500

Internal Server Error

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

curl --request POST \ --url 'https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/positions/cover' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"currencies":["BTC"]}{,"all":true}'

const url = 'https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/positions/cover'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"currencies":["BTC"]}{,"all":true}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/positions/cover") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"currencies":["BTC"]}{,"all":true}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/positions/cover', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"currencies":["BTC"]}{,"all":true}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/positions/cover" payload = {,"currencies":["BTC"]}{,"all":true} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)