Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.datalinks.com/llms.txt

Use this file to discover all available pages before exploring further.

This short guide shows you how to set up the SDK, run a basic query, and get your first useful results.
For a step-by-step walkthrough that uses real example data to solve a practical scenario, see the QuickStart API/SDK Guide.
1

Install

Install the DataLinks SDK if you haven’t already.
2

Configure

  1. Ensure the required environment variables for the DataLinks API are configured:
    • HOST
    • DL_API_KEY
    • NAMESPACE
    • OBJECT_NAME (optional)
    Alternatively, you can use a .env file in the root of your project for configuration.
3

Example

Import the SDK and initialize the configuration:
from datalinks.api import DataLinksAPI, DLConfig

# Initialize configuration
config = DLConfig.from_env()

# Instantiate API client
client = DataLinksAPI(config=config)

# Run a minimal query
data = client.query_data(query="*", include_metadata=False)
print(data)