Portfolio Analysis API

Returns potential revenue for securities with utilization and lending rates.

Endpoint

POST /public/portfolio-analysis

Full URL: https://api.sharegain.com/public/portfolio-analysis

Headers

Header	Value
X-SG-Authorization	[token]
X-SG-ApiVersion	1
Content-Type	application/json

Request Body

{
  "identifiers": [
    {
      "requestKey": "1",
      "isin": "US5949181045",
      "ticker": "MSFT",
      "exchangeCode": "US"
    }
  ]
}

Instrument Identifier Parameters

Parameter	Type	Description
requestKey	string	Mandatory. Unique identifier for the request
isin	string	ISIN format, e.g., US5949181045
compositeBbgId	string	CompositeBbgId format
ticker	string	Ticker format, e.g., TSLA
exchangeCode	string	Exchange code, e.g., UW
mic	string	MIC code, e.g., XNAS
countryCode	string	Country code, e.g., US

Response

{
  "successResults": [
    {
      "requestKey": "1",
      "isin": "US5949181045",
      "potentialReturn": 2.6,
      "lendingRateBps": 420,
      "utilization": 0.86,
      "date": "2023-09-28T12:03:12.579Z"
    }
  ],
  "failureResults": [],
  "totalCount": 1
}

Rate Limits

Limit Type	Value
Requests per day	4,000
Requests per minute	200
Max items per day	200,000
Max items per request	200