Get Started

Quickstart

From zero to your first authenticated response in five short steps.

1. Get Your API Key

Buy any dataset from the catalog, then subscribe to its API. A key scoped to that subscription is issued instantly and shown on the dataset page.

2. Make Your First Call

Send your key as a Bearer token. This reads the first three vendors from the live Vendor Master Data dataset. The vendors table has more than sixty columns, so select narrows the response to five of them.

terminalbash

# Keep the key in the environment, never in the command history.
export DATLYNE_API_KEY="dtl_live_ab3k9x_your-40-char-secret"

# vendors has 60+ columns, so narrow it with select to start.
curl -sS https://www.datlyne.com/v1/vendor-master-data-general-us/vendors \
  -H "Authorization: Bearer $DATLYNE_API_KEY" \
  -G --data-urlencode "select=vendor_id,vendor_name,vendor_type,country_code,vendor_status" \
     --data-urlencode "limit=3"

A successful response returns a page of records, a cursor for the next page, and a flag telling you whether more records remain:

200 OKjson

{
  "data": [
    {
      "vendor_id": "0000100001",
      "vendor_name": "Feilong Tool & Die Co., Ltd.",
      "vendor_type": "principal",
      "country_code": "CN",
      "vendor_status": "inactive"
    },
    {
      "vendor_id": "0000100002",
      "vendor_name": "Danbury Underwood Software Group LLC",
      "vendor_type": "service",
      "country_code": "US",
      "vendor_status": "active"
    },
    {
      "vendor_id": "0000100003",
      "vendor_name": "Empire Switchgear Company",
      "vendor_type": "manufacturer",
      "country_code": "US",
      "vendor_status": "active"
    }
  ],
  "next_cursor": "WyIwMDAwMTAwMDAzIl0",
  "has_more": true
}

3. Page Through Every Row

Paging is keyset based, not offset based: there are no page numbers and rows never shift between pages. Send the next_cursor you were given back as the cursor parameter, and stop when has_more is false.

terminalbash

curl -sS https://www.datlyne.com/v1/vendor-master-data-general-us/vendors \
  -H "Authorization: Bearer $DATLYNE_API_KEY" \
  -G --data-urlencode "select=vendor_id,vendor_name,vendor_type,country_code,vendor_status" \
     --data-urlencode "limit=3" \
     --data-urlencode "cursor=WyIwMDAwMTAwMDAzIl0"

4. Filter and Pick Columns

Filter with column=operator:value, choose columns with select, and order with sort. Sorting is ascending only. Unknown column names are rejected before the query runs, so a typo returns 400 instead of a silently empty page. The operator is never optional either: a bare ?country_code=US returns 400, so write ?country_code=eq:US.

terminalbash

# Active US manufacturers and distributors with YTD spend over 250,000,
# smallest spend first (sort is ascending only).
curl -sS https://www.datlyne.com/v1/vendor-master-data-general-us/vendors \
  -H "Authorization: Bearer $DATLYNE_API_KEY" \
  -G --data-urlencode "vendor_status=eq:active" \
     --data-urlencode "country_code=eq:US" \
     --data-urlencode "vendor_type=in:manufacturer,distributor" \
     --data-urlencode "spend_ytd=gt:250000" \
     --data-urlencode "select=vendor_id,vendor_name,city,spend_ytd,naics_code" \
     --data-urlencode "sort=spend_ytd" \
     --data-urlencode "limit=100"

The same four moves work on all eight tables in this dataset. Table paths use hyphens even though the column names use underscores, so vendor_contacts is read at /v1/vendor-master-data-general-us/vendor-contacts. Every child table carries a vendor_id you can join back to vendors.

5. Go to Production

There is no dataset version pinning today. Every request reads the latest synced data. Watch your quota on the rate limits page as you scale up.

Curious about a database connection or GraphQL? Both are planned but not yet available. See Direct SQL for status.