Review

Get Annual Review

Generate a Spotify Wrapped-style annual financial review from the user's full year of transaction data.

get/api/review/annual/{user_id}

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/review/annual/{user_id}
  • Auth: HTTP bearer

Path parameters

user_idstring uuid required

Response

Successful Response

yearinteger required
total_earnednumber required
total_spentnumber required
total_savednumber required
savings_ratenumber required
spending_personalitystring required
personality_descriptionstring required
personality_emojistring required
fun_factsstring[] required

Changes

No recorded changes to this operation across all 2 revisions of this API.