Getting Started
You request API access yourself, from the Sharegain lender platform. No IP whitelisting is needed.
Step 1: Sign the API Access Agreement
- Sign in at lender.sharegain.com.
- Click your initials at the bottom of the left-hand menu, then click Settings.
- On the API access tab, click Review & sign agreement.
- Read the Sharegain API Access Agreement. Tick the box confirming you are authorised to accept it on your organisation's behalf, then click Approve & submit.
Anyone with a login to your organisation's main lender account can do this. Your developer does not need a login, only the key.
Can't see Settings?
API access is requested by the main lender account. If Settings isn't in your menu, contact your Sharegain account manager.
Step 2: Approval
Our Client Success team reviews the request, usually within 1–2 business days. Until then, the API access tab shows Request submitted.
If the request is declined, the tab shows Request declined with the reason. Contact your Sharegain account manager to resolve it.
Step 3: Copy your key
Once approved, your key appears on the same API access tab under Live API key. Click Copy and pass it to your developer securely.
Send the key in the X-SG-Authorization header on every request. See Authentication.
Keep your key secret
The key does not expire. Store it in a secrets manager and use it only from your servers. If it is ever exposed, contact support@sharegain.com and we will replace it.
Quick Example
curl -X POST https://api.sharegain.com/public/portfolio-analysis \
-H "X-SG-Authorization: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"identifiers": [
{
"requestKey": "1",
"isin": "US5949181045"
}
]
}'