No logo available for GSA Entity API to DuckDB connector icon

Load GSA Entity API data to DuckDB

Build a GSA Entity API to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the GSA Entity API API base URL, auth, endpoints, and incremental loading.

SourceGSA Entity APIGSA Entity API API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

The GSA Entity API provides access to SAM.gov entity registration, exclusion, and vendor information for federal acquisition and system integration purposes. Everything needed to build a working GSA Entity API → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your GSA Entity API to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from GSA Entity API to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the GSA Entity API API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


GSA Entity API API at a glance

Base URLhttps://api.sam.gov/entity-information/
Example endpointGET entity-information/v4/entities
Records found atresults
Authenticationall requests require an API key in headers, with optional HTTP Basic auth for system accounts — sent in the Authorization header, prefixed Basic
Also requiredAccept, Content-Type, x-api-key
PaginationNot paginated
API referencehttps://open.gsa.gov/api/entity-api/

These values come from the GSA Entity API API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the GSA Entity API API?

Authentication requires an API key passed via the 'x-api-key' header. For system-level access or sensitive data, HTTP Basic authentication (username and password) is required in the 'Authorization' header alongside the API key.

1. Get your credentials

To obtain credentials, log in to your account at https://sam.gov. For a personal API key, navigate to your Profile > Account Details page, locate the Public API Key section, and click the eye icon; you will need to enter a one-time password sent to your registered email to view the key. For system-level access, request a System Account via the System Accounts widget on your Workspace page. Once approved, you must set a password for the system account; you can then retrieve the System Account API Key from the new section that appears in the widget by entering your system password. Note that SAM.gov API keys are distinct from api.data.gov keys.

2. Add them to .dlt/secrets.toml

[sources.gsa_entity_api_source] api_key = "your_sam_api_key_here" system_username = "your_system_account_id" system_password = "your_system_account_password"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What GSA Entity API data can I load into DuckDB?

These are the GSA Entity API endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
entities_v4entity-information/v4/entitiesGETresultsRetrieve entity information (v4)
entities_v3entity-information/v3/entitiesGETresultsRetrieve entity information (v3)
entities_v2entity-information/v2/entitiesGETresultsRetrieve entity information (v2)
entities_v1entity-information/v1/entitiesGETresultsRetrieve entity information (v1)
extractsdata-services/v1/extractsGETresultsRequest entity/exclusions extract metadata

How do I load only new GSA Entity API records?

The GSA Entity API API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

{"name": "entities_v4", "endpoint": { "path": "entity-information/v4/entities", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated GSA Entity API pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading entities and exclusions from the GSA Entity API API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def gsa_entity_api_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.sam.gov/entity-information/", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "entities_v4", "endpoint": {"path": "entity-information/v4/entities", "data_selector": "results"}}, {"name": "entities_v3", "endpoint": {"path": "entity-information/v3/entities", "data_selector": "results"}} ], } yield from rest_api_resources(config) def load_gsa_entity_api_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="gsa_entity_api_pipeline", destination="duckdb", dataset_name="gsa_entity_api_data", ) load_info = pipeline.run(gsa_entity_api_source()) print(load_info) if __name__ == "__main__": load_gsa_entity_api_to_duckdb()

Run it with python gsa_entity_api_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query GSA Entity API data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("gsa_entity_api_pipeline").dataset() df = data.entities_v4.df() print(df.head())

SQL:

SELECT * FROM gsa_entity_api_data.entities_v4 LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the GSA Entity API to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw GSA Entity API loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load GSA Entity API data to?

dlt loads into any of these — only the destination argument changes:

DestinationExample value
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for GSA Entity API to DuckDB?

Request dlt skills, commands, AGENT.md files, and AI-native context.