PARAMETERS
Primary keys
A primary key is one or more attributes that uniquely define a row in a table.
To retrieve a table’s primary key(s), simply make a metadata call and scroll to the end.
Filters
You can customize table calls by adding various filter parameters to your query.
Filters are unique to each table. Consequently, it is important to read the table's documentation to see which filters are available for your calls.
You may also make a metadata call to see all available filters for a table: https://www.quandl.com/api/v3/datatables/{publisher}/{table}/metadata
Filter operators
The following are filter operators, which can be appended to all filters, regardless of the table. The filter operators will further modify your results.
| Filter | Required | Description |
|---|---|---|
| = | yes | Modifies the parameter to return values equal to the requested value |
| .gt= | no | Modifies the parameter to return values greater than the requested value |
| .lt= | no | Modifies the parameter to return values less than the requested value |
| .gte= | no | Modifies the parameter to return values greater than or equal to the requested value |
| .lte= | no | Modifies the parameter to return values less than or equal to the requested value |
Parameters
There are four optional parameters that are common to all tables:
| Parameter | Required | Description |
|---|---|---|
| qopts.columns | no | Request data from specific columns by passing the qopts.columns parameter. If you want to query for multiple columns, include the column names separated by a comma. |
| qopts.export | no | Good for large queries; the data requested will be packaged into a zip file for download. |
| qopts.per_page | no | The number of results per page that can be returned, to a maximum of 10,000 rows. (Large tables will be displayed over several pages.) |
| qopts.cursor_id | no | Each API call returns a unique cursor ID that identifies the next page of the table. Including the cursor ID in your API call will allow you to page through the table. A null cursor ID means that the current page will be the last page of the table. For more on downloading entire tables, click here. |
Updated almost 7 years ago