docs / 01

Quickstart

From an account to your first parcel record in four steps, using only curl.

1. Create an account

Sign up at /signup and verify your email address. Verification issues the 30-day sandbox trial token (50 credits) and delivers it by email. The raw token is shown once and can never be read back.

2. Or issue a trial token from the API

If you already have a session cookie, you can issue the trial token directly. A second active trial for the same account is refused with 409.

curl -X POST https://parcel.reeeally.ai/api/tokens/trial \
  -H "Cookie: $SESSION_COOKIE"

A 201 response carries the raw token once, alongside its plan and expiry:

{
  "token": "pk_trial_...",
  "token_prefix": "pk_trial_...",
  "plan": "trial",
  "credits": 50,
  "expires_at": "2026-11-03T00:00:00.000Z",
  "period_start": "2026-10-04T00:00:00.000Z",
  "period_end": "2026-11-03T00:00:00.000Z"
}

Store the token now. Only its SHA-256 hash is persisted, so parcel cannot recover or re-send the raw value.

3. Check the API is up

curl https://parcel.reeeally.ai/health

4. Serve parcel records

Send the token as a bearer credential. 1 credit = 1 parcel record: every record actually served consumes one credit, and the response reports the remaining balance and any overage. Paid plans include 4,000 records per month at $59, with overage at $0.05 per additional record.

curl "https://parcel.reeeally.ai/api/parcels?county_fips=06037&limit=100" \
  -H "Authorization: Bearer $PARCEL_TOKEN"
{
  "parcels": [ { "id": "06037:APN-1", "apn": "APN-1", "address": "...", "area_acres": 0.23 } ],
  "count": 1,
  "metering": {
    "plan": "trial",
    "credits_remaining": 49,
    "overage_records": 0,
    "overage_amount_cents": 0
  }
}

5. Track your usage

The usage endpoint returns the calling token and its most recent ledger entries.

curl https://parcel.reeeally.ai/api/usage \
  -H "Authorization: Bearer $PARCEL_TOKEN"

Next steps

  • Read the Records page for every field in a parcel response.
  • Read Coverage to see which counties have data and how to filter them.
  • Read Errors for the status codes and error codes the API returns.