Ctrl+K

Fetch billable events given query parameters, defaults to all in the last 24 hours

get/api/v2/admin/billableEvent

Query Parameters

  • fromEnterprisearray[string]
    array of enterprise ids to fetch the BillableEvents of
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • startDatestring<date-time>
    Fetches transfers with a `date` that is greater than or equal to the given timestamp
  • endDatestring<date-time>
    Fetches transfers with a `date` that is less than the given timestamp
  • coinarray[string]
    array of coins to filter the BillableEvents for
    Example: btc

200 Response

billableEvents array[object]
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
deterministicId string required
this is an id that will always stay the same for a txid, even if its regenerated txid + '|' + coin + '|' + destination
coin string required
A cryptocurrency or token ticker symbol.
Example: btc
asset string required
this is the asset, will match the coin unless it is offchain, in that case it will be the base asset eq. ofcbtc --> btc; ofcltc --> ltc
Example: btc
amount integer
The total value (in base units) sent by this BillableEvent (may be approximate for ETH and other coins where amounts in base units can exceed 2^53 - 1)
amountString string required
Example: 2000000
Match pattern: ^-?\d+$
coinBigUnits integer required
The total value (in big units) sent by this BillableEvent
coinBigUnitsString string required
The total value (in big units) sent by this BillableEvent represented as a String
Example: 2000000
Match pattern: ^-?\d+$
date string <date-time>required
The date of the Transfer this BillableEvent was created from
fromWallet string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
fromWalletTypeAny ofrequired
The type describes who owns the keys to the wallet and how they are stored. `cold` wallets are wallets where the private key of the user key is stored exclusively outside of BitGo's system. `custodial` means that this wallet is a cold wallet where BitGo owns the keys. Only customers of the BitGo Trust can create this kind of wallet. `custodialPaired` means that this is a hot wallet that is owned by the customer but it will be linked to a cold (custodial) wallet where BitGo owns the keys. This option is only available to customers of BitGo Inc. BitGo stores an encrypted private key for the user key of `hot` wallets. `trading` wallets are trading accounts where the coin is `ofc`. `distributedCustody` means You manage one key and another key agent manages the second key. BitGo manages the third key
Allowed values: cold custodial custodialPaired hot trading distributedCustody advanced
fromWalletBillingEnterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
fromWalletBillingEnterpriseType string
fromWalletBillingEnterpriseBitGoEntity string
BitGo Organization related to this entity
Allowed values: BitGo Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore BitGo Europe ApS BitGo Mena Fze BitGo Custody MENA FZE BitGo India
fromWalletBillingEnterprisePricingPlan string
fromEnterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
fromEnterpriseType string
fromEnterpriseBitGoEntity string
BitGo Organization related to this entity
Allowed values: BitGo Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore BitGo Europe ApS BitGo Mena Fze BitGo Custody MENA FZE BitGo India
fromEnterprisePricingPlan string
isBlockchainFee boolean
whether the BillableEvent is for a blockchain fee
isChange boolean
whether the BillableEvent is for a change output
isPayGo boolean
whether the BillableEvent is for a paygo output
toAddress string
the address the BillableEvent is sending to
toWallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
toWalletTypeAny of
The type describes who owns the keys to the wallet and how they are stored. `cold` wallets are wallets where the private key of the user key is stored exclusively outside of BitGo's system. `custodial` means that this wallet is a cold wallet where BitGo owns the keys. Only customers of the BitGo Trust can create this kind of wallet. `custodialPaired` means that this is a hot wallet that is owned by the customer but it will be linked to a cold (custodial) wallet where BitGo owns the keys. This option is only available to customers of BitGo Inc. BitGo stores an encrypted private key for the user key of `hot` wallets. `trading` wallets are trading accounts where the coin is `ofc`. `distributedCustody` means You manage one key and another key agent manages the second key. BitGo manages the third key
Allowed values: cold custodial custodialPaired hot trading distributedCustody advanced
toWalletBillingEnterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
toWalletBillingEnterpriseType string
toWalletBillingEnterpriseBitGoEntity string
BitGo Organization related to this entity
Allowed values: BitGo Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore BitGo Europe ApS BitGo Mena Fze BitGo Custody MENA FZE BitGo India
toWalletBillingEnterprisePricingPlan string
toEnterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
toEnterpriseType string
toEnterpriseBitGoEntity string
BitGo Organization related to this entity
Allowed values: BitGo Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore BitGo Europe ApS BitGo Mena Fze BitGo Custody MENA FZE BitGo India
toEnterprisePricingPlan string
transferId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
txid string required
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
usd number required
the usd value of the billable event, calculated by multiplying the usdRate time the amount of coin being sent
usdString string required
the usd value captured as a string
usdRate number required
The USD price at the time the Transfer was created
version number required
the version of the billable event schema the event was generated with

400 Response

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