Skip to main content

Using the Pulse REST API

How to access Pulse data programmatically via the REST API.

Written by John Kotowski

What the API gives you

The Pulse REST API lets you query pricing data, diffs, watchlists, and account info programmatically — ideal for building internal tools, automating reports, or integrating Pulse into your own product. If you'd rather connect an AI assistant, see Connecting via MCP instead.

Getting your API key

  1. Open the account menu (your name, bottom-left) then Settings.

  2. Open API Access. Your API key (prefixed ps_) is shown there — click the eye icon to reveal it and the copy icon to copy it.

  3. Keep it secret: treat it like a password and never share it publicly.

Under Advanced you can Regenerate your key (which immediately invalidates the old one) or Revoke it.

Base URL

All public API requests go to https://api.pricingsaas.com/functions/v1/api

Authentication

Pass your API key as a Bearer token in the Authorization header of every request, in the form Authorization: Bearer YOUR_API_KEY. A quick way to verify your key is to call the free GET /status endpoint, which returns your plan, entitlements, credit balance, and watchlist usage.

Public API surface

  • Company — search and find companies, get a company by slug, and discover or retrieve diffs (for example GET /companies/search, GET /companies/find, GET /companies/{slug}, and GET /companies/{slug}/diffs).

  • Status — check your plan, entitlements, and usage including credit balance and watchlist limits (GET /status). This call is free.

  • Watchlists — create and manage owner-scoped watchlists of tracked companies.

  • Digests — create and manage scheduled email digest configs (schedule and recipients).

  • Webhooks — register a URL to receive push notifications when pricing changes are detected.

Full reference

The complete, always-current API reference (every endpoint, parameter, and response schema) is linked from Settings → API Access → View Full Documentation.

Credits and limits

API calls consume credits from your plan balance, charged on every call (programmatic calls are not de-duplicated the way the web app is). Per-endpoint costs are listed in the full reference, and some read endpoints such as GET /status are free. See How credits work. For high-volume or Enterprise API access, contact [email protected].

Did this answer your question?