v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
PortfolioSearch

Search for trader portfolios or Smart Portfolios by free-text query

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.


Returns a relevance-ranked list of publicly visible trader portfolios or Smart Portfolios matching the query string. The required type parameter determines which index is searched. Results are capped at limit.

get/api/v1/portfolios/search

Query parameters

type'trader' | 'smart-portfolio' required

Portfolio type to search.

querystring required

Free-text search string.

limitinteger

Maximum number of results to return.

Headers

x-request-idstring uuid required
Example:a82207b6-dc14-4fc6-8adc-36d2f58cee13

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

Successful search response