Skip to content
API Catalog/
Vanda Analytics Timeserie...
/Reference

Search aggregates and optionally single securities

Request

Comprehensive search across aggregates, their constituents and optionally single securities.

When include_single_security=False (default):

  • Searches aggregate fields: vanda_id, type, subtype
  • Searches constituent securities: vanda_id, figi, symbol, name, sector, industry
  • Returns only aggregate results

When include_single_security=True:

  • Each search returns up to 'limit' results (total max 2*limit)
  • Results include 'result_type' field to distinguish aggregate vs single_security

Returns aggregates/securities matching any criteria (cached 5 minutes).

Security
HTTPBearer
Query
querystring, [ 1 .. 100 ] characters(Query)required

Search query

Example:query=AAPL
typesstring or null(Types)
Example:types=INDEX,SECTOR
Any of:

Comma-separated aggregate types to filter

string
active_onlyboolean(Active Only)

Only search active aggregates/securities

Default:true
limitinteger, [ 1 .. 100 ](Limit)

Maximum results per search type

Default:50
include_single_securityboolean(Include Single Security)

Include single security search results

Default:false
curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/aggregates/vanda-msvc-aggregates/aggregates/reference/search?query=AAPL&types=INDEX%2CSECTOR&active_only=true&limit=50&include_single_security=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
Array [
Any of:

Aggregate metadata schema.

]
Response
[
  {
    "id": 0,
    "vanda_id": "string",
    "type": "string",
    "subtype": "string",
    "active": true,
    "result_type": "aggregate"
  }
]

Search aggregates and optionally single securities

Request

Comprehensive search across aggregates, their constituents and optionally single securities.

When include_single_security=False (default):

  • Searches aggregate fields: vanda_id, type, subtype
  • Searches constituent securities: vanda_id, figi, symbol, name, sector, industry
  • Returns only aggregate results

When include_single_security=True:

  • Each search returns up to 'limit' results (total max 2*limit)
  • Results include 'result_type' field to distinguish aggregate vs single_security

Returns aggregates/securities matching any criteria (cached 5 minutes).

Security
HTTPBearer
Query
querystring, [ 1 .. 100 ] characters(Query)required

Search query

Example:query=AAPL
typesstring or null(Types)
Example:types=INDEX,SECTOR
Any of:

Comma-separated aggregate types to filter

string
active_onlyboolean(Active Only)

Only search active aggregates/securities

Default:true
limitinteger, [ 1 .. 100 ](Limit)

Maximum results per search type

Default:50
include_single_securityboolean(Include Single Security)

Include single security search results

Default:false
curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/aggregates/vanda-msvc-aggregates/aggregates/reference/search?query=AAPL&types=INDEX%2CSECTOR&active_only=true&limit=50&include_single_security=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
Array [
Any of:

Aggregate metadata schema.

]
Response
[
  {
    "id": 0,
    "vanda_id": "string",
    "type": "string",
    "subtype": "string",
    "active": true,
    "result_type": "aggregate"
  }
]