Asset

Asset (Model)

  • asset_id
    Type: string
  • created_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • currency
    Type: object · AssetCurrency

    AssetCurrency (Interface)

    • currencyType
      Type: string | nullenum
      values
      • currency_type_unspecified
      • currency
      • currency_equivalent
    • paymentCurrency
      Type: string | null
  • description
    Type: string
  • equity
    Type: object · AssetEquity

    AssetEquity (Interface)

    • fractionable
      Type: boolean | null
    • liquidate
      Type: boolean | null
    • type
      Type: string | nullenum
      values
      • equity_type_unspecified
      • common_stock
      • preferred_stock
      • preferred_adr
      • special_stock
  • factor
    Type: number
  • fixed_income
    Type: object · AssetFixedIncome

    AssetFixedIncome (Interface)

    • callable
      Type: boolean | null
    • callType
      Type: string | nullenum
      values
      • call_type_unspecified
      • ordinary
      • special
      • make_whole
      • regulatory
    • convertible
      Type: boolean | null
    • couponFrequency
      Type: string | nullenum
      values
      • coupon_frequency_unspecified
      • semi_annual
      • monthly
      • at_maturity
      • zero
      • quarterly
      • annual
    • couponRate
      Type: string | null
    • couponType
      Type: string | nullenum
      values
      • coupon_type_unspecified
      • coupon_type_fixed
      • coupon_type_zero
    • duration
      Type: string | null
    • firstCouponDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • fixedIncomeStatus
      Type: string | nullenum
      values
      • fixed_income_status_unspecified
      • outstanding
      • matured
      • called
      • unknown
    • fixedIncomeSubtype
      Type: string | nullenum
      values
      • fixed_income_subtype_unspecified
      • bond
      • strips
      • bill
      • note
      • tips
    • fixedIncomeType
      Type: string | nullenum
      values
      • fixed_income_type_unspecified
      • municipal
      • corporate
      • cd
      • agency
      • treasury
      • government
      • foreign_government
    • insured
      Type: boolean | null
    • issueDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • issuer
      Type: string | null
    • issueSize
      Type: string | null
    • lastCouponDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • maturityDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • nextCallDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • nextCouponDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • parValue
      Type: string | null
    • perpetual
      Type: boolean | null
    • priceAtIssuance
      Type: string | null
    • spRating
      Type: string | null
    • spRatingDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • underlyingSymbol
      Type: string | null
  • fmv
    Type: number
  • fmv_as_of
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • icon_url
    Type: string
  • investment_rate_yearly
    Type: number
  • isin
    Type: string
  • issuing_region_code
    Type: string
  • logo_url
    Type: string
  • mutual_fund
    Type: object · AssetMutualFund

    AssetMutualFund (Interface)

    • fundFamily
      Type: string | null
    • largeOrderNotificationAmount
      Type: string | null
    • mutualFundType
      Type: string | nullenum
      values
      • mutual_fund_type_unspecified
      • bond
      • money_market_fund
      • equity
    • shareClass
      Type: string | null
  • name
    Type: string
  • option
    Type: object · AssetOption

    AssetOption (Interface)

    • callPut
      Type: string | nullenum
      values
      • call_put_unspecified
      • call
      • put
    • exerciseStyle
      Type: string | nullenum
      values
      • exercise_style_unspecified
      • american
      • european
    • expirationDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • optionRoot
      Type: AssetOptionRoot | null · AssetOptionRoot

      AssetOptionRoot (Interface)

    • optionType
      Type: string | nullenum
      values
      • option_type_unspecified
      • standard
      • non_standard
    • rootSymbol
      Type: string | null
    • seriesDate
      Type: string | nullFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • settlementMethod
      Type: string | nullenum
      values
      • settlement_method_unspecified
      • physical
      • cash
    • settlementType
      Type: string | nullenum
      values
      • settlement_type_unspecified
      • standard
      • non_standard
    • strikePrice
      Type: string | null
  • originating_region_code
    Type: string
  • symbol
    Type: string
  • type
    Type: stringenum
    values
    • type_unspecified
    • equity
    • option
    • currency
    • digital
    • fdic_synthetic
    • fixed_income
    • mutual_fund
    • alt_investment
  • updated_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • usable
    Type: boolean