Bourse.MarginLoan (bourse v0.1.0)

Copy Markdown View Source

Unified margin loan data.

Represents the result of a cross/isolated margin borrow or repay.

Fields

  • id - Loan / transaction id when the venue returns one
  • currency - Unified currency code
  • amount - Borrowed or repaid amount (string or number per venue)
  • symbol - Unified market symbol (isolated margin only)
  • timestamp - Loan time in milliseconds
  • datetime - ISO 8601 datetime string
  • info - Raw exchange response

Summary

Functions

JSON Schema for the MarginLoan unified type.

Types

t()

@type t() :: %Bourse.MarginLoan{
  amount: term() | nil,
  currency: String.t() | nil,
  datetime: String.t() | nil,
  id: term() | nil,
  info: map() | nil,
  symbol: String.t() | nil,
  timestamp: integer() | nil
}

Functions

schema()

@spec schema() :: map()

JSON Schema for the MarginLoan unified type.