CapableDocs

Search the API docs

Find an endpoint or guide

Get an API key

SecuritiesGet a security

Securities

Get a security

One security by id, with vesting computed for today.
GET/api/v1/securities/{id}

Requires an API key with the securities:read scope · How keys work

Path parameters

  • idstringrequired

    The security's id, as returned by the list endpoint.

Response 200

The security object itself, not wrapped in data.

  • idstring

    Unique id.

  • certificateIdstring

    Certificate or grant id, such as CS-12 or OPT-9.

  • typestring

    Kind of security.

    One ofshareoptionrsarsusafenotewarrantunitprofits_interestphantom

  • statusstring

    Draft securities are not on the cap table until they are published in the app.

    One ofdraftoutstandingcancelledexercisedconvertedtransferredrepurchasedsettledexpired

  • stakeholderIdstring

    The holder.

  • shareClassIdstring | null

    Share class the security is in or converts into.

  • equityPlanIdstring | null

    Equity plan an option, RSA or RSU was granted from.

  • quantitynumber

    Shares or units granted. For a SAFE or note, the principal in US dollars.

  • outstandingnumber

    Quantity still outstanding today, after exercises, cancellations and repurchases.

  • exercisednumber

    Quantity exercised so far.

  • cancellednumber

    Quantity cancelled so far.

  • vestednumber | null

    Quantity vested today. Null for SAFEs and notes.

  • issueDatedate

    Issue or grant date, YYYY-MM-DD.

  • boardApprovalDatedate | null

    Date the board approved it, when on record.

  • pricePerSharenumber | null

    Purchase price per share, in US dollars.

  • exercisePricenumber | null

    Exercise or strike price per share, in US dollars.

  • optionTypestring | null

    Tax type of an option. iso_nso is a grant split at the $100,000 ISO limit.

    One ofisonsoiso_nso

  • expirationDatedate | null

    Date an option or warrant expires.

  • vestingobject | null

    The vesting schedule, when the security has one.

    ›Show 4 attributes
    • idstring

      Schedule id.

    • namestring

      Schedule name, such as 4-year monthly, 1-year cliff.

    • descriptionstring

      The schedule in words.

    • commencementDatedate | null

      Vesting start date, YYYY-MM-DD.

  • safeTypestring | null

    Kind of SAFE.

    One ofpost_moneypre_moneymfnuncapped

  • valuationCapnumber | null

    SAFE or note valuation cap, in US dollars.

  • discountPercentnumber | null

    SAFE or note discount, as a percentage such as 20.

  • interestRatenumber | null

    Convertible note interest rate, as a percentage.

  • maturityDatedate | null

    Convertible note maturity date.

Example

Request
curl https://capable.so/api/v1/securities/sec_7tq0c2n5vz3d \
  -H "Authorization: Bearer $CAPABLE_API_KEY"
Response · 200 OK
JSON
{
  "id": "sec_7tq0c2n5vz3d",
  "certificateId": "OPT-9",
  "type": "option",
  "status": "outstanding",
  "stakeholderId": "stk_4m8q2xw7ka1p",
  "shareClassId": "cls_common01x9",
  "equityPlanId": "pln_2024plan7b",
  "quantity": 48000,
  "outstanding": 48000,
  "exercised": 0,
  "cancelled": 0,
  "vested": 19000,
  "issueDate": "2025-03-20",
  "boardApprovalDate": "2025-03-18",
  "pricePerShare": null,
  "exercisePrice": 0.42,
  "optionType": "iso",
  "expirationDate": "2035-03-20",
  "vesting": {
    "id": "vst_4y1c_month",
    "name": "4-year monthly, 1-year cliff",
    "description": "25% after 12 months, then 1/48 monthly over the next 36 months",
    "commencementDate": "2025-03-03"
  },
  "safeType": null,
  "valuationCap": null,
  "discountPercent": null,
  "interestRate": null,
  "maturityDate": null
}

Errors

StatusWhen
401 UnauthorizedThe key is missing, invalid or revoked, or its creator lost access.
402 Payment requiredThe company has no active plan in good standing: its trial ended without one, a payment has failed for over 21 days, or its subscription is paused or has ended.
403 ForbiddenThe key does not have the securities:read scope.
429 Too many requestsThe key went over its rate limit. Wait for Retry-After seconds.
404 Not foundNo security with this id belongs to the company.

Every error has the same shape. See Errors, limits and conventions.