Getting Started
Create an app, pick your first call, make it. Most developers are done in under fifteen minutes.
Before you start
- A Wefunder account.
- An application in the developer portal. If you manage a company or a syndicate on Wefunder you can create one right away; otherwise request access and we will open the portal for you. Every app gets a test key and a live key the moment it exists.
One idea to hold onto
Almost everything in the API belongs to a user, a company, or a syndicate, and your app reaches one by being installed on it. An installation is the connection: your app, one user or company or syndicate, and the scopes they granted. A token is what you call with, and every token comes from an installation. Public deal data is the one exception and needs no install.
Pick your first call
Explore the catalog
No user, no install. Exchange your key for a read:public token and read the public deal catalog. Two commands.
Read a user's portfolio
The investor authorizes your app once; that consent is the install on the user. Then GET /portfolio.
Sync your company's investments
For founders. Install on your own company from the portal, mint its token there, then GET /investments. No OAuth to write; the recipe runs end to end.
Act for a company or syndicate
Install your app on the company or syndicate, get the installation token, make your first request as it. The code there is the syndicate case.
The three tracks live on the home page quickstart with copyable code in cURL, JavaScript, Python, and Ruby; the founder recipe is a guide of its own.
Go deeper
Authentication
OAuth 2.0 with PKCE, client credentials for public data, token prefixes, refresh, common failures.
Sandbox
Your own seeded test realm, with test credentials and test logins. Explore and portfolio work there today; installs are live-only for now.
Install your app
Your first install, step by step: from the portal with no code, and from the API. Personal token, company token, the install link, checking it worked.
Installations reference
Who can install, tiers and scopes, tokens, the install link, revoking.
What's next
- Building for investors: Investor portfolio.
- Building for syndicate leads: the Syndicate API.
- Building for founders: Sync investments to your CRM is the whole route, portal install to webhook; Investments and webhooks are its reference.
- Something breaks: Error handling, and quote the
request_id.
Creating SPVs and invite links through the API is an invite-only preview; ask us for preview access before building on it. Hosted investment sessions and syndicate join sessions are in beta and open to any app installed on its own company or syndicate.