Data API is not available on the Free plan.
Data API v2 is available for both AWS and GCP cloud providers.
Overview
The Data API v2 provides a simplified way to query your data using SQL. Unlike the previous version, you no longer need to manage application initialization or pagination manually. Simply submit your query and download the results.Output Formats
Data API v2 supports two output formats:Parquet Mode
Parquet is a columnar storage format that offers better compression and performance for analytical queries. This is the recommended format for most use cases. Advantages:- Better compression and smaller file sizes
- Faster query performance
- Preserves data types and schema information
- Ideal for large datasets
- May have limitations with certain data types (see Known Limitations)
CSV Mode
CSV (Comma-Separated Values) is a simple text format that’s widely supported by most tools and applications. Advantages:- Universal compatibility
- Easy to read and inspect
- Simple to import into spreadsheet applications
- Larger file sizes compared to Parquet
- No schema information preserved
- All values are represented as strings
How It Works
1
Create an API Key
Go to your Workspace settings and create an API Key, it will be necessary to use all Data API endpoints.
2
Create your query
Nekt Data API v2 is powered by AWS Athena (for AWS organizations) or GCP BigQuery (for GCP organizations), using standard SQL syntax.The most common use case is to query the data of a specific table:You can also specify the output format (parquet or csv) in your request. If not specified, parquet is used by default.
query.sql
Use SQL filters, joins, where clauses and many more SQL statements to refine your query.
3
Download the results
After submitting your query, the API will automatically process it and provide you with a download link to get the results in your chosen format.
Pseudo code implementation
Next Steps
- Review the Known Limitations for your cloud provider and output format
- Check the SQL Query endpoint documentation for detailed API reference