API documentation

Quick start

curl https://goodsacrossborders.com/api/v1/index.json

curl https://goodsacrossborders.com/api/v1/rules/vape-e-cigarette_thailand_traveling.json

curl https://goodsacrossborders.com/api/v1/openapi.json

Endpoints (v1)

TypeScript SDK

A tiny, dependency-free client for the API. Source lives in packages/sdk/ in the repo; publish on npm is pending the user-space release pass.

import { createClient } from "@goodsacrossborders/sdk";

const gab = createClient();
const rule = await gab.getRule("vape-e-cigarette", "thailand", "traveling");
console.log(rule.status); // 'prohibited'

const countries = await gab.listCountries();
console.log(countries.length);

Embed widget

Embed a compact rule card on your site with a single <script> tag. See a live demo →

<div data-gab-rule="vape-e-cigarette_thailand_traveling"></div>
<script async src="https://goodsacrossborders.com/embed/rule.js"></script>

By use case

Eight worked examples (TS + Python + curl) live on /developers/examples:

• Fetch a country profile.
• Look up a single rule (item × country × purpose).
• Filter rules client-side.
• Sync rule changes nightly (changelog).
• Build a duty-rate lookup.
• Power a customs-warning widget at checkout.
• List trade lanes with an active FTA.
• Drop into an LLM tool-use schema (function calling).

Rate limits

No rate limits. The API is a set of static JSON files served from a CDN. Standard HTTP caching applies. Mirror the files locally for offline use.

Caching

• Every JSON file under /api/v1/ is static — same URL returns the same bytes between deploys.
• The CDN sets Cache-Control to a moderate TTL; honour it.
• Use If-Modified-Since / ETag for conditional refresh — most CDNs respond 304 Not Modified when unchanged.
• For SDK consumers: listRules() is large (5,000+ entries); fetch once per build cycle and cache in your own layer.
• /developers/changelog is the canonical signal that the dataset has moved.

Licence & attribution

All data is licensed CC-BY 4.0. When republishing or integrating, attribute as “Goods Across Borders — goodsacrossborders.com”. Commercial use is permitted within that attribution. Honest reproduction of the data requires keeping the lastVerified dates and sourceUrls alongside the content — they are load-bearing, not cosmetic.

Pricing

The public API is free and unmetered, and will remain free for all documented-rule data. Pricing page documents what the future paid tier will and won't cover.