Quickstart

Data Feeds is in early access. Contact us to set up a subscription; the API and sync client described here open to early access customers first.

This walks through the whole sync loop with the REST API. The sync client runs the same loop for you with one command.

Create an API key

In Ploti, open Settings, API keys and create a key with the feeds scope. Store it where you keep secrets.

export PLOTI_API_KEY=pk_live_...

Find the places you cover

curl https://api.ploti.ai/v1/places?state=FL \
  -H "Authorization: Bearer $PLOTI_API_KEY"

{
  "places": [
    {
      "id": "us-fl-12095",
      "name": "Orange County",
      "state": "FL",
      "kind": "county",
      "datasetCounts": { "permits": 6, "zoning": 3, "code_enforcement": 2 }
    }
  ],
  "nextCursor": null
}

curl -X POST https://api.ploti.ai/v1/subscriptions \
  -H "Authorization: Bearer $PLOTI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: orange-permits-1" \
  -d '{
    "name": "Orange County permits",
    "places": ["us-fl-12095"],
    "topics": ["permits"],
    "delivery": { "type": "pull" }
  }'

Load the snapshots

The manifest lists every dataset in the subscription with links to its current snapshot, and the event cursor it is current as of.

curl https://api.ploti.ai/v1/subscriptions/sub_8f3k2m/manifest \
  -H "Authorization: Bearer $PLOTI_API_KEY"

{
  "subscriptionId": "sub_8f3k2m",
  "generatedAt": "2026-10-18T14:02:11Z",
  "eventCursor": "evt_0000018f2a9c",
  "datasets": [
    {
      "datasetId": "ds_orange_fl_building_permits",
      "title": "Building permits",
      "place": "us-fl-12095",
      "topic": "permits",
      "version": 42,
      "schemaVersion": "2.1",
      "files": {
        "snapshot": [
          {
            "url": "https://files.ploti.ai/...part-0000.parquet",
            "format": "geoparquet",
            "rows": 184220,
            "bytes": 21933012,
            "sha256": "9b1f..."
          }
        ],
        "schema": { "url": "https://files.ploti.ai/...schema.json", "format": "json", "rows": 0, "bytes": 4120, "sha256": "c03a..." },
        "expiresAt": "2026-10-18T15:02:11Z"
      }
    }
  ]
}

Load each snapshot into a table, keyed on _ploti_record_id. Save eventCursor.

Apply events

Read the events after your cursor, apply each in order, and save the id of the last one you applied.

curl "https://api.ploti.ai/v1/subscriptions/sub_8f3k2m/events?after=evt_0000018f2a9c" \
  -H "Authorization: Bearer $PLOTI_API_KEY"

Event	What to do
`dataset.updated`	Fetch the version, apply its changes file: upsert or delete by `_ploti_record_id`.
`dataset.schema_changed`	Additive: add the new columns. Breaking: review, then migrate your table.
`dataset.added`	Load the new dataset’s snapshot.
`dataset.resync_required`	Replace the table with the version’s snapshot.
`dataset.removed`	Stop expecting updates for that dataset.

Get told instead of polling

Add a webhook for the subscription’s events. Use it as the signal to read the event log; the log stays the source of truth.

Data Feeds

Concepts

Tools

Terms

API reference