GET prosper/v1/historic_yields
Returns Historic Yields for the specified aggregation unit (e.g. days, weeks, months, quarters, years) for the specified look back temporal amount

Default output format, with no extension specified, is JSON. Appending a suffix to the url, prior to the parameters can be used to specify an output format. Valid output formats are JSON or CSV.

JSON Example: https://api.higenoki.com/prosper/v1/historic_yields.json?aggregation=week&look_back_unit=year&look_back=1

Errors

Code Description
422 Request not logical

Params

Param name Description
aggregation
required

Temporal unit for bucketing yields

Validations:

  • Must be one of: day, week, month, quarter, year.
look_back
optional

Temporal amount for looking back; e.g. ‘5’ with a ‘look_back_unit’ equal to ‘month’ would mean look back five months default is 365 days

Validations:

  • Must match regular expression /^[1-9][0-9]$/.
look_back_unit
optional

Temporal unit for looking back in time; this is paired with the ‘look_back’ parameter; default is ‘day’

Validations:

  • Must be one of: day, week, month, quarter, year.
order_direction
optional

Sort direction to return results in

Validations:

  • Must be one of: desc, asc.