Sign in
Explore

Get a company page

Changed on

The company page behind an offering, as structured data — the "click a company" step after /explore. Addressed by the co_... id every offering carries in company.id.

Keeps apart the three raised numbers the page shows and readers conflate: current_raise.amount_raised (this campaign's live rounds combined, on Wefunder), past_rounds[] (prior rounds the page lists, each tagged source: wefunder for rounds observed here or reported for founder-disclosed off-platform rounds), and totals.profile_total_raised (the number on the page's ticker bar). Every figure comes from the same policy the page uses, so the API never disagrees with the site.

Who has a page. Every company whose profile wefunder.com lists publicly — the same set the site's search bar returns (published, not invite-only, searchable or with a live Form C; accredited-only companies need an accredited viewer) — plus the /explore set. A funded company, or one the viewer may see no round of, renders with raising: false and current_raise: null; its history is in wefunder_rounds. Logged-in view (read:explore) additionally covers the vault / syndicate-led companies the site shows an accredited viewer, and the round described is the one the page would show that viewer. A valid id for a company outside the viewer's set is a 404, never a partial payload.

get/companies/{id}

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/companies/{id}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: read:public)
    • OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: read:explore)

Path parameters

idstring required

The company's id (co_...).

Response

Successful response

Example response

{
  "data": {
    "id": "co_8Kd0aB3xQ9k2vF8mNp1zT5wY",
    "type": "company",
    "attributes": {
      "past_rounds": [
        {
          "exemption": {
            "family": "reg_cf",
            "label": "Reg CF"
          }
        }
      ],
      "wefunder_rounds": [
        {
          "exemption": {
            "family": "reg_cf",
            "label": "Reg CF"
          },
          "security": {
            "label": "SAFE",
            "terms": {
              "valuation_cap": "10000000",
              "discount_percent": "20"
            }
          }
        }
      ]
    }
  }
}

Changes

  • f7ce1e834ec5Revision changes
    • info

      the security scope read:public was added to the endpoint's security scheme bearerAuth

    • info

      the security scope read:explore was removed from the endpoint's security scheme bearerAuth

  • b13c74d0be35Revision changes
    • info

      endpoint added