v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Users Info

Get user live portfolio

Rate limit: 60 requests per 60 seconds. This is a dedicated limit for this endpoint — it is not shared with (pooled across) any other endpoint, so the full rate is available to this endpoint alone.

get/api/v1/user-info/people/{username}/portfolio/live

Path parameters

usernamestring required

The username of the user to retrieve the live portfolio for.

Headers

x-request-idstring uuid required
Example:d758c8d2-a202-46fb-99db-b6f8e36857e8

A unique request identifier.

x-api-keystring password required
Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required
Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

OK

realizedCreditPctnumber

Credit as a percentage of the realized credit

unrealizedCreditPctnumber

Credit as a percentage of the unrealized credit