Income

Information such as the average monthly income value, the estimated salary received by a user, the yearly salary, and the income sources count are part of the parameters that get returned on the Income endpoint.

Data returned from the Income Endpoint

average_monthly_income

This returns the mean of the user's monthly income. We compute for this using sum of income divided by durations.

monthly_income

This is the actual salary the user receives every month. Sometimes you will see multiple results which means the user has a recurrent or multiple streams of income.

yearly_income

This is the yearly estimated income of a user.

income sources

This calculates the number of income streams or sources in the user’s transactions. Some users might have two or more income source either from freelancing or family.

API Reference

Response Object

{
  "average_income": 4500000,
  "monthly_income": 8600000,
  "yearly_income": 103200000,
  "income_sources": 0
}

Income Fields