Getting Started

Monitor your first source in under five minutes.

This walks through creating an account, installing the CLI, and watching TrackChanges catch a real change end to end.

01Create an account

Sign up via the API to get your account, workspace, and API key in one call. Your API key is shown once, so save it immediately.

# create an account
curl -X POST https://api.trackchanges.io/signup \
  -H "Content-Type: application/json" \
  -d '{"email": "you@company.com", "password": "choose-a-strong-password"}'
Save your API key. It's returned once in the signup response as api_key. There's no way to view it again after this response.

02Install the CLI

The tch CLI wraps the API for everyday use: subscribing to sources, checking diffs, managing webhooks.

$ pip install trackchanges
$ tch --help

03Point the CLI at your account

Write your API key to the CLI's config file so every command authenticates automatically.

$ tch login
# prompts for email + password, writes ~/.trackchanges/config

04Subscribe to a source

Point TrackChanges at any OpenAPI or Swagger spec. Polling starts automatically.

$ tch subscribe https://api.stripe.com/openapi.json --alias stripe-api
# silence is success — no output means it worked

05Check for changes

Once a new version is detected, view the diff directly from the CLI.

$ tch diffs stripe-api
$ tch show-diff <diff_id>

06Get notified automatically

Add a webhook so you don't have to check manually. Any URL works, Slack included.

$ tch poll add-webhook stripe-api https://hooks.slack.com/services/...