Query Parameters Reference
This page documents the parameters for thequery function across all CloudQuant Data Liberator SDKs. Parameter names are consistent across languages; only the types and calling conventions differ.
Parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
name | The name of the dataset to query | String | Yes |
symbols | Security trading symbol(s) to query. Omit to retrieve all symbols in the dataset. | String or List | No |
as_of | The point in time for data retrieval. Defaults to now. Accepts any past date to view data as it was known on that date. Format: YYYY-MM-DD HH:MM:SS (time portion optional). | String | No |
back_to | The start date for time series data. Retrieves all data “back to” the specified date. Format: YYYY-MM-DD HH:MM:SS (time portion optional). | String | No |
url | The CloudQuant Data Liberator server URL. Defaults to https://api.cloudquant.ai. Can also be set to an IP address, e.g. http://127.0.0.1:47753. | String | No |
system | The authorized system name for your query. Almost always "API". | String | No |
fields | Filter the returned columns to only those specified. Mandatory fields cannot be removed. | String or List | No |
stats | Set to "total" to receive a JSON result containing the count per symbol instead of data rows. | String | No |
crux_key | API key for querying Crux datasets. | String | No |
compress | Data compression on the wire. CloudQuant uses compression by default. Set to "compressed_transfer" or true. | String or Boolean | No |
json_xfer | JSON transfer mode. Usually false. | Boolean | No |
user | Your user identifier as assigned by CloudQuant. | String | No |
token | Your assigned authentication token. | String | No |
debug_stream | Output stream for log/debug information. Language-specific type (e.g., stderr() in R, std::ostream* in C++, System.IO.TextWriter in C#). | Stream | No |
warning_stream | Output stream for warning information. Same type conventions as debug_stream. | Stream | No |
record_limit | Limit the number of records returned. | Integer | No |
SQL | SQL passthrough query (where supported by the dataset). | String | No |
Date Parameter Behavior
If
as_of and back_to are identical, the result will not be a time series.Authentication
Theuser and token parameters can be provided per-query or configured once at the SDK level:
- Python: Set via the
liberator.jsonfile in your working directory - JavaScript: Use
liberator.set_default("query", credentials)to avoid passing them every time - RESTful: Include in each request’s JSON body
- Other SDKs: Loaded from
liberator.jsonin the working directory