Skip to content

Latest commit

 

History

History
104 lines (77 loc) · 8.07 KB

README.md

File metadata and controls

104 lines (77 loc) · 8.07 KB

COINBASE_PRIME

1.1.2 v3

This document was generated automatically. Please see README Generator for more info.

Environment Variables

Required? Name Description Type Options Default
API_ENDPOINT The HTTP URL to retrieve data from string https://api.prime.coinbase.com
✅ ACCESS_KEY The API key for Coinbase Prime auth string
✅ PASSPHRASE The passphrase for Coinbase Prime auth string
✅ SIGNING_KEY The signing key for Coinbase Prime auth string
{KEY_NAME}_ACCESS_KEY Alternative API key, use apiKey in input to select string
{KEY_NAME}_PASSPHRASE Alternative passphrase, use apiKey in input to select string
{KEY_NAME}_SIGNING_KEY Alternative signing keyauth, use apiKey in input to select this string
BACKGROUND_EXECUTE_MS The amount of time the background execute should sleep before performing the next request number 10000

Data Provider Rate Limits

Name Requests/credits per second Requests/credits per minute Requests/credits per hour Note
default 25 Using the most restrictive rate limit. Docs: IP address at 100 requests per second (rps). Portfolio ID at 25 rps with a burst of 50 rps.

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string balance, wallet balance

Balance Endpoint

balance is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ portfolio The portfolio ID to query the balance of string
✅ symbol The symbol to return the balance for string
type The balance type to return string total, trading, vault total
apiKey Alternative api keys to use for this request, ${apiKey}_ACCESS_KEY ${apiKey}_PASSPHRASE ${apiKey}_SIGNING_KEY required in environment variables string

Example

Request:

{
  "data": {
    "endpoint": "balance",
    "portfolio": "abcd1234-123a-1234-ab12-12a34bcd56e7",
    "symbol": "BTC",
    "type": "total",
    "apiKey": ""
  }
}

Wallet Endpoint

wallet is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ portfolio The portfolio ID to query the balance of string
✅ symbols The symbol to return the balance for string[]
type The balance type to return string trading, vault, wallet_type_other, web3 vault
chainId The ID of the chain to return string mainnet, testnet mainnet
network The network to return string bitcoin
batchSize The number of addresses to fetch at a time number 100
apiKey Alternative api keys to use for this request, {$apiKey}_ACCESS_KEY {$apiKey}_PASSPHRASE {$apiKey}_SIGNING_KEY required in environment variables string

Example

Request:

{
  "data": {
    "endpoint": "wallet",
    "portfolio": "abcd1234-123a-1234-ab12-12a34bcd56e7",
    "symbols": ["BTC"],
    "type": "vault",
    "chainId": "mainnet",
    "network": "bitcoin",
    "batchSize": 10,
    "apiKey": ""
  }
}

MIT License