API Keys

Issue a 14-day SDK developer trial key (100 calls/day)

User-sim Item D 2026-05-06 (OWNER ratified): issue ONE 14-day SDK developer trial key per user lifetime. 100 calls/day cap on a curated 8-endpoint moat subset (insiders / 13F / institutional- holdings consensus / BDC / short-interest + search; the "institutional-holdings consensus" name dates from the 2026-05-20 rename — see rename-history). After 14 days the key auto-reverts to free-tier limits — the developer's stub script keeps working at lower velocity until they upgrade.

Gates (CISO pre-flight):

  1. require_auth — must be logged in
  2. user.email_verified must be True (defense against disposable- email signup-flood)
  3. v60 partial unique index ensures one active trial per user (DB-layer enforcement; UniqueViolation → 409 Conflict)
post/api/keys/trial

Request

  • Base URL: https://www.oxfordledge.com (the document declares no server; this is the origin it was published from)
  • URL: https://www.oxfordledge.com/api/keys/trial
  • Auth: none declared

Response

Successful Response

statusstring required

'ok' on success

keystring required

Raw trial API key, shown ONCE. Distinct ol_trial_ prefix.

prefixstring required

Stable key prefix for display in subsequent UI surfaces

namestring required

Human-readable key name

expires_atstring required

ISO 8601 timestamp (now + 14 days)

is_trialboolean required

Always True for this endpoint

days_remaininginteger required

Whole days until trial expires (always 14 at issuance)

daily_capinteger required

Per-day call quota (always 100 per OWNER ratification)

idinteger required

Internal api_keys.id for the new key

Example response

{
  "status": "ok",
  "key": "ol_trial_a1b2c3d4e5f6...",
  "prefix": "ol_trial_a1b2c3d4",
  "name": "Developer trial",
  "expires_at": "2026-05-20T17:30:00+00:00",
  "days_remaining": 14,
  "daily_cap": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.