This resource represents the earnings of your connected customers in their investment accounts. Information such as the amount earned, the narration, the date this earning was made, asset name, the sale price, quantity sold etc are all returned.

API Object

{
    "_id": "618bb1238a2dcf366b563b2e",
    "amount": 3719,
    "narration": "Sell 1 shares of CHGG at 37.19 PART fill",
    "date": "2020-04-17T14:11:14.689Z",
    "asset": {
      "symbol": "CHGG",
      "name": "Chegg",
      "sale_price": 4684,
      "quantity_sold": 1
    }
},

Earnings Fields

Field

Description

Types

_id

The ID of the earning

string

amount

The total amount of earning value

integer

narration

The narration based on this earning

string

date

The date this earing was received

string

asset.symbol

The asset symbol for this earning

string

asset.name

The asset name for this earning

string

asset.sale_price

The sale price for this earning

integer

asset.quantity_sold

The quantity sold for this earning

integer


Did this page help you?