API · for data teams

The answer for operators. The features for your models.

Operators use LocalPulse's dashboards, alerts and actions. If your organisation also has a forecasting or data-science team, the feature export hands them the same per-day inputs LocalPulse uses, already signed for each of your businesses.

Start free trial Talk to us

Endpoint

One call per business and date range.

GET /api/v1/features with a key created by an owner or admin under Settings → API. Up to 366 days per call, rate-limited per key. Included in the Group plan.

curl -H "Authorization: Bearer lpk_…" \
  "https://localpulse.prompt6.com/api/v1/features?business=<id>&from=2026-01-01&to=2026-03-31&format=csv"

Auth: Authorization: Bearer lpk_… or X-API-Key. Keys are shown once, stored hashed, and can be revoked at any time.
Formats: format=json (default), csv or ndjson.
Scope: a key only reads businesses in its own organisation.

What each row holds

Features, effects and forecasts, per day.

business_id, date, template_id: One row per business per day. The template says which industry profile the business runs on.
drivers: Feature values for that day: weather against normal, holidays and eves, school holidays, paydays, disruption, cruise passengers, inbound-market features and any driver discovered for this business.
signed_effects: The fitted log effect of each driver on that day (β × x), including the combined lift and suppression from events. Negative values hold demand back.
events: Each event touching that day with its signed mean effect for this business and Jev's confidence.
inbound: Visitor-market features: seasonal share, holidays in origin countries (lagged by lead time and stay), exchange-rate index and arrivals momentum, where configured.
pace: Units on the books, the same point last year, and growth-adjusted pace, for booking-led businesses.
forecast: The P10 / P50 / P90 forecast stored for that day and the date it was made, so you can backtest without look-ahead.
actual: The business's own daily value, once known.

Only aggregated data is exported: daily totals and counts by country, never customer names or contact details. Features that need an external source (official arrivals, exchange rates, cruise schedules) are absent rather than guessed when that source isn't configured.

Give your data team the local context.

Start a trial, or contact us about the Group plan and API access.

Start free trial Open a demo