Coming from the v1.2 API
If you read Wefunder data through the legacy /api/v1.2/companies and /api/v1.2/fundraise/{id} endpoints (a static access_token query parameter), this page maps every field you get there to where it lives in this API. Authentication, paging and the Explore endpoints themselves are covered in Build a Deal Aggregator with the Explore API.
Two differences apply everywhere:
- Ids are opaque strings. A company is
co_…and a round is an offering,ofr_…. There are no integer ids in this API. - Money is a decimal string in USD (
"1235000"), never a number. Parse it as a decimal, not a float.
Company fields
/api/v1.2/companies → GET /companies/{id} (data.attributes).
| v1.2 | This API | Notes |
|---|---|---|
id | data.id | co_… |
common_name / name | name | |
legal_name | legal_name | As the company entered it. The name on its filed Form C is business.legal_name in GET /companies/{id}/disclosures. |
tagline | tagline | |
card_photo_url | card_image_url | Absolute URL, or null. |
city, state | location.city, location.state | Plus location.country. |
company_type | legal_form | Free text, not normalized. The filed Form C's value is business.legal_form in /disclosures. |
ein | — | Not served. It is on the company's filed Form C. |
home_url (company_url) | website_url | Always an absolute URL, or null. |
wefunder_url | url | The company's Wefunder page. |
facebook_url, twitter_url | facebook_url, twitter_url | Always absolute URLs (a stored handle is expanded), or null. linkedin_url and instagram_url are also served. |
privacy_search / public | promotion_opt_in | Whether the company asked to be promoted as widely as possible. false does not hide anything you can fetch, but the company has asked not to be promoted. |
what_we_do, our_ambition, quick_facts | — | Not served as separate fields. The company's own narrative is GET /companies/{id}/pitch. |
tags | industries, business_models on each offering | The curated tags the Explore page filters by. |
fundraise_ids | wefunder_rounds[].offering_id | Every round the company ran on Wefunder that you may see, live and closed. |
Round fields
v1.2 round fields (from /api/v1.2/fundraise/{id} and the v1.2 companies payload) → GET /offerings/{id} (data.attributes). GET /explore returns the same offering shape for every live round.
| v1.2 | This API | Notes |
|---|---|---|
id / fundraise_id | data.id | ofr_… |
company_id, company_name | data.company, company_name | data.company is the co_… id. |
exemption | exemption | { family, subtype, label }, e.g. reg_cf / "Reg CF". |
ttw / is_testing_the_waters | testing_the_waters | A testing-the-waters round takes reservations, not investments. |
state | status | upcoming, open, closed or canceled. |
start_at / start_date | started_at | |
close_at / end_date | closes_at while open, closed_at once closed | A round can stay open past closes_at. Use status to tell whether it accepts investments. |
funding_target | funding_target | |
max_funding_target | max_funding_target | For a Reg CF round, the Form C maximum. Otherwise the maximum the company set, or null. |
min_purchase | min_investment | |
funding_progress / amount_raised_on_wefunder | amount_raised | This offering only. For the company's combined live rounds, use current_raise.amount_raised on GET /companies/{id}. |
total_amount_raised_on_and_off_wefunder | totals.profile_total_raised on GET /companies/{id} | The number on the company page's ticker. |
number_of_investors | investor_count | |
oversubscribed | current_raise.oversubscribed on GET /companies/{id} | Or compare amount_raised with funding_target. |
latest_form_c_url | form_c_url | The latest accepted Form C or Form C/A on SEC EDGAR. Reg CF only. |
use_wefund, wefund_legal_name | spv_legal_name | The SPV investors hold through. Null means they hold the security directly. |
funding_portal_id, funding_portal_name | — | Not served. Every Wefunder Reg CF round is offered through Wefunder Portal LLC. |
primary_fundraise_id, testing_the_waters_fundraise_id | current_raise.offering_id and current_raise.offering_ids on GET /companies/{id} | The live round the company page shows, and every live round combined with it. Each offering's testing_the_waters and exemption say which is which. |
security and its terms (safe_cap, note_rate, security_price, …) | security | { type, label, terms }, typed by security. See the Security schema in the API reference. |
api_notes | — | Not served. |