Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIFinance

Share routes

Every Share Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Share.

NounSystemRun by
ShareEquityFounder

Share.get

Returns one Share by id. Verb page.

Text
GET /{namespace}/shares/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Share.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
shareSharerequiredThe Share.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Share",
  "$id": "https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW",
  "share": {
    "$id": "https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW",
    "$type": "Share",
    "class": "common",
    "quantity": 1
  },
  "links": {
    "self": "https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW",
    "up": "https://api.sb/leaseline.app/shares"
  },
  "actions": {
    "transfer": "https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW/transfer"
  }
}

Share.list

Returns Shares, newest first, one page at a time. Verb page.

Text
GET /{namespace}/shares

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
shareslist of SharerequiredOne page of Shares.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/shares?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Share",
  "shares": [
    {
      "$id": "https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW",
      "$type": "Share",
      "class": "common",
      "quantity": 1
    }
  ],
  "meta": {
    "limit": 20,
    "after": "share_yiQ4iEmeOW"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/shares?limit=20",
    "next": "https://api.sb/leaseline.app/shares?after=share_yiQ4iEmeOW"
  }
}

Share.issue

Issue records new Shares of one class to a Holder under a board-approved Agreement, with the certificate or book entry. Verb page.

Text
POST /{namespace}/shares/issue

Body, as JSON: the inputs. Emits Share.issued.

Inputs

InputTypeRequiredDescription
holderHolderrequiredThe Holder who receives the Shares.
classstringrequiredThe share class.
quantityintegerrequiredHow many Shares.
pricemoneyrequiredThe price paid per Share.
agreementAgreementrequiredThe board-approved Agreement that authorizes the issue.

Returns

OutputTypeRequiredDescription
shareSharerequiredThe issued Share record.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/shares/issue \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"holder":"holder_e2Dm5Y6QGO","class":"Example class","quantity":1,"price":{"amount":29,"currency":"USD"},"agreement":"agreement_zHIUnX8LwY"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "share": {
    "$id": "https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW",
    "$type": "Share",
    "class": "common",
    "quantity": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Share.issue",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Share.transfer

Transfer moves Shares from one Holder to another under a signed Agreement, within the Company’s transfer restrictions. Verb page.

Text
POST /{namespace}/shares/{share}/transfer

Path: share. Body, as JSON: the other inputs. Emits Share.transferred.

Inputs

InputTypeRequiredDescription
shareSharerequiredThe Share record to transfer from.
toHolderrequiredThe Holder who receives them.
quantityintegerrequiredHow many Shares move.
agreementAgreementrequiredThe signed transfer Agreement.

Returns

OutputTypeRequiredDescription
shareSharerequiredThe new Share record held by the receiving Holder.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
A transfer the bylaws or a right of first refusal blockrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW/transfer \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"holder_e2Dm5Y6QGO","quantity":1,"agreement":"agreement_zHIUnX8LwY"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "share": {
    "$id": "https://api.sb/leaseline.app/shares/share_yiQ4iEmeOW",
    "$type": "Share",
    "class": "common",
    "quantity": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Share.transfer",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

request, send, supersede

Previous

Statement

Next