APIs

The following APIs power potential tax center experiences that can enhance the in-app customer experience. Examples of use cases powered by the following API endpoints are covered below in the "Example Guides" section.

Gains

The Gains API can be used to manage gains and losses related to asset disposals. It calculates gains by tracking disposed tax lots based on your chosen accounting method.

/gains - A detailed collection of all combined cost bases, proceeds, and gains/losses for a user.
/gains/breakdown - Get the user's gains broken into long and short term gains/losses and the total, by specified period.
/gains/summary - Get the user's total gains for a period.

Inventory

The Inventory API offers a streamlined solution to retrieve a user's present inventory, providing essential information such as total cost and total quantity for each asset. Inventory represents the non-disposed set of assets that a user has, and can power unrealized gains.

/inventory - Get a summary and list of undisposed lots for the given asset for a specific account. Enables showing unrealized gains, cost basis, tax lots.
/inventory/summaries - Retrieve the summary of total cost and total quantity for each undisposed asset for a specified account. Enables showing a summary of a user's undisposed assets.