Query Parameters

Here are query parameter guidelines and some query parameters common to many viaNexus Data Platform Data endpoints.

Parameter Guidelines

Parameter values must be comma-delimited when requesting data for multiple items.
- (e.g., filter=symbol,volume)
Parameters are case-insensitive, unless otherwise specified.
- (e.g., Both filter=symbol and filter=SYMBOL work.)
Parameter values must be URL-encoded.
- (e.g., Encode AIG+ as AIG%2b to use as a parameter value.)

Common Parameters

Many viaNexus Data Platform Data endpoints support the following query parameters.

Response Format: format
Response Filter: filter
Response Schema: schema

Response Format

The format parameter specifies the response format.

Format	Content Type	Example
json (default)	application/json	`format=json` (not required since JSON is default)
csv	text/csv	`format=csv`

Example - Intraday Equity Prices CSV response format

Request:

curl -X GET "https://api.blueskyapi.com/v1/data/core/intraday_prices/msft?format=csv&token=YOUR_TOKEN"

Response:

date,minute,label,high,low,open,close,average,volume,notional,numberOfTrades,symbol
2023-12-22,09:30,09:30 AM,373.8,373.52,373.665,373.75,373.687,2000,747374.5,15,MSFT
2023-12-22,09:31,09:31 AM,373.58,373.57,373.57,373.58,373.575,200,74715,2,MSFT
...

Response Filter

The filter parameter returns a specified subset of the response data. Pass a comma-delimited list of response attributes to filter on.

Note: Each endpoint reference page Response Attributes section lists the endpoint's response attributes.

Filter values are case-sensitive; specify response attribute names exactly as they're specified in the endpoint's reference page.

Example - News response filter

Request:

curl -X GET "https://api.blueskyapi.com/v1/data/core/news/tsla?filter=symbol,datetime,headline&token=YOUR_TOKEN" | jq

Response

[
  {
    "symbol": "TSLA",
    "datetime": 1747141049000,
    "headline": "Thumbs Down to Tesla Model Y Revamp as Even Discounts Can’t Drive Demand",
  }
]

With parameter setting filter=symbol,datetime,headline, the News endpoint returns only the values for the symbol, datetime, and headline response attributes. The jq command formats the JSON content.

Response Schema

Requests with the schema=true parameter setting return only the endpoint response schema (i.e., the response attribute names and types).

For example, if you're building a database table from endpoint results, you should match the column types to the endpoint response attribute types. Executing the endpoint with schema=true shows you the response value types you're working with.

Example - Intraday Equity Prices response schema

Request:

curl -X GET "https://api.blueskyapi.com/v1/data/core/intraday_prices/msft?schema=true&token=YOUR_TOKEN" | jq

Response:

[
  {
    "date": "string",
    "minute": "string",
    "label": "string",
    "high": "number",
    "low": "number",
    "open": "number",
    "close": "number",
    "average": "number",
    "volume": "number",
    "notional": "number",
    "numberOfTrades": "number"
  }
]