GET

List keys

Path Params

coin string required

A cryptocurrency or token ticker symbol.

Responses

200

Response Body

object

keys array of objects required
ONE OF
- encryptedPrv string
  
  The encrypted private key
- id string required
  
  matches ^[0-9a-f]{32}$
- isBitGo boolean
  
  True, if this key is owned by BitGo
- source string enum
  
  backupbitgocolduser
- type string enum required
  
  A value from a string enum denoting what kind of key this is. Defaults to “independent” indicating an on-chain key is requested. If set to “tss” this tells us that a “tss” key is requested.
  
  Defaults to independent
  
  tssindependent
- pub string
  
  public part of a key pair
- encryptedPrv string
  
  The encrypted private key
- id string required
  
  matches ^[0-9a-f]{32}$
- isBitGo boolean
  
  True, if this key is owned by BitGo
- source string enum required
  
  backupbitgocolduser
- type string enum required
  
  A value from a string enum denoting what kind of key this is. Defaults to “independent” indicating an on-chain key is requested. If set to “tss” this tells us that a “tss” key is requested.
  
  Defaults to independent
  
  tssindependent
- commonKeychain string
  
  The commonKeychain for the key if this is a MPC key. This value is required to be set when the type is set to “tss” and when the source is either “user” or “backup”. Setting this indicates to BitGo that the owner of the key has received all key shares they needed for generating their key. This value is the concatenation of the common public key (32-byte) with the common chaincode (32-byte) as a hex string.
- commonPub string
  
  The common public key. This value is required to be set for MPC keys when the source is either "user" or "backup". Setting this indicates to BitGo that the owner of the key has received all key shares they needed for generating their key.

400

Bad Request

Response Body

object

error string required

Human-readable error message
requestId string required

Client request id
context object

Properties that apply to a specific error name
name string required

Error code

const url = 'https://app.bitgo-test.com/api/v2/coin/key'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; 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/v2/coin/key") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/v2/coin/key', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/coin/key" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "keys": [ { "encryptedPrv": "string", "id": "59cd72485007a239fb00282ed480da1f", "isBitGo": false, "source": "user", "type": "tss", "pub": "xpub661MyMwAqRbcGMVhmc7wqQRYMtcX9LAvSj1pjB213y5TsrkV2uuzJjWnjBrT1FUeNWGPjaVm5p7o6jdNcQJrV1cy3a1R8NQ9m7LuYKA8RpH" } ] }