Skip to main content

Akoya
Documentation

Taxlots

GET

https://sandbox-products.ddp.akoya.com/taxlots/{version}/{providerId}/{accountId}/{holdingId}

The taxlots API allows you to retrieve tax lots of consumer-permissioned accounts.

Path Parameters

  1. version*

    stringdefault: v2

    Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2

  2. providerId*

    stringdefault: mikomo

    Id of provider

  3. accountId*

    string

    Account Identifier

  4. holdingId*

    string

    Consumer's holdingId under investments

Headers

  1. x-akoya-interaction-type

    string

    Optional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.

Query Parameters

  1. offset

    string

    The number of items to skip before the first in the response. The default is 0

  2. limit

    string

    The maximum number of items to be returned in the response. The default is 50

Responses

  1. 200

    OK

    Response Body

      accountId

      string

      holding

      object

          holdingId

          string

          securityId

          string

          securityIdType

          string

          taxLots

          array of objects

            object

              originalPurchaseDate

              string

              quantity

              integer

              purchasedPrice

              integer

              costBasis

              number

              currentValue

              integer

              positionType

              string

    Headers

    1. x-akoya-interaction-idstring

      Akoya supplied interaction id used for logging and error tracking

  2. 401

    602 - Customer not authorized

    Response Body

      code

      integer

      message

      string

  3. 403

    The `providerId` is wrong or your app doesn't have a subscription to the provider.

    Response Body

      code

      integer

      message

      string

  4. 404

    701 - Tax Lots not found. The `holdingId` may be wrong.

    Response Body

      code

      integer

      message

      string

CTRL + K

Try it

Authorization

const options = {
	"method": "GET",
	"headers": {
		"x-akoya-interaction-type": "batch"
	}
}};
fetch('https://sandbox-products.ddp.akoya.com/taxlots/v2/mikomo//?offset=&limit=', options)
  .then(response => response.json())
  .catch(err => console.error(err));
AccountsCustomers guide