examples

Examples

Each example shows how to configure the FDW against a real API, with complete server options, table definitions, and sample queries.

No Auth Required

Example	API	Features
nws	Weather.gov	GeoJSON responses, nested path extraction, custom User-Agent
carapi	CarAPI	Page-based pagination, query pushdown, auto-detected data wrapper
pokeapi	PokéAPI	Offset-based pagination, path params, auto-detected results wrapper

Auth Required

Example	API	Auth	Features
github	GitHub REST API	Bearer token	Path params, custom headers, items wrapper, search pushdown
threads	Meta Threads API	OAuth token (query param)	Cursor-based pagination, path params, query pushdown

Feature Coverage

Feature	Weather.gov	CarAPI	PokéAPI	GitHub	Threads
IMPORT FOREIGN SCHEMA (spec_url)	✓	✓	✓	✓
IMPORT FOREIGN SCHEMA (spec_json)					✓
YAML spec support			✓
Page/offset-based pagination		✓	✓	✓
Cursor-based pagination	✓				✓
URL-based pagination (auto-detected)			✓	✓
Path parameter substitution	✓		✓	✓	✓
Query parameter pushdown	✓	✓		✓	✓
LIMIT pushdown	✓	✓	✓	✓	✓
GeoJSON extraction (object_path)	✓
Nested response path (response_path)	✓
Bearer token / API key auth				✓
Query param auth (api_key_location)					✓
Custom headers	✓			✓
Type coercion (int, bool, timestamptz)	✓	✓	✓	✓	✓
camelCase to snake_case matching	✓
Single object response	✓		✓	✓
Auto-detected wrapper key		✓	✓	✓
Debug mode	✓	✓	✓	✓
attrs full JSON column	✓	✓	✓	✓	✓