Bourse.Currency (bourse v0.1.0)

Unified currency data.

Describes a currency or token supported by an exchange, including deposit/withdraw capabilities and network information.

Fields

id - Exchange-specific currency ID
code - Unified currency code (e.g., "BTC")
name - Full currency name
numeric_id - Numeric ID (some exchanges)
precision - Decimal precision
type - "crypto" or "fiat"
active - Whether the currency (or a network under networks) is considered usable. When derived from per-chain deposit/withdraw flags, the rollup is an authored per-venue decision (active_requires_both on the currency field map): true requires both directions, false accepts either. First-class venues must declare the flag; there is no silent default for them (task 482). Some venues (e.g. Binance coin-level) set currency active from a non-chain field such as trading — see that venue's carve register.
deposit - Whether deposits are enabled
withdraw - Whether withdrawals are enabled
fee - Default withdrawal fee
fees - Per-network withdrawal-fee map (Bourse fees, %{} when none)
limits - Amount/withdraw/deposit min/max limits (Bourse limits)
networks - Network-specific deposit/withdraw info
info - Raw exchange response

Mirrors Bourse's safeCurrencyStructure key set exactly (no margin — that is a non-canonical extra only a few venues emit; the unified struct stays to the shared 14-key shape the static-response fixtures assert against).

Summary

Types

t()

Functions

schema()

JSON Schema for the Currency unified type.

Types

t()

@type t() :: %Bourse.Currency{
  active: boolean() | nil,
  code: String.t() | nil,
  deposit: boolean() | nil,
  fee: number() | nil,
  fees: map(),
  id: String.t() | nil,
  info: map() | nil,
  limits: map() | nil,
  name: String.t() | nil,
  networks: map() | nil,
  numeric_id: integer() | nil,
  precision: number() | nil,
  type: String.t() | nil,
  withdraw: boolean() | nil
}

Functions

schema()

@spec schema() :: map()

JSON Schema for the Currency unified type.