Crowd Valley
The Crowd Valley API is used to build online platforms and marketplaces globally for managing private placements, securities, real estate, crowdfunding, peer-to-peer lending, and public stock trading. The public REST API provides an end to end server side application, which supports the technical back office requirements for client side applications of various kinds in the online investing and…
Crowd Valley endpoints
| Method | Endpoint | Description |
|---|---|---|
| API Health | ||
| GET |
Crowd Valley API health status / |
Check the current health status of the Crowd Valley API. |
| GET |
Check the status of your network /{network} |
Check that your network has been set up and is available through the API with your API key. |
| Self | ||
| GET |
Logged-in user's account information /{network}/self |
Populate information on an user's private account page. |
| PATCH |
Update a user's profile information /{network}/self |
Update the logged-in user's profile information. |
| PATCH |
Accept Terms and Conditions /{network}/self/acceptTerms |
Accept End User Terms and Conditions. Accepting Terms can be implemented as part of creating a user or as a separate step. |
| GET |
Retrieve the user's investments /{network}/self/investments |
Retrieve a list of the user's investments. This will include open investment offers as well as closed investments. |
| GET |
The User's Organizations /{network}/self/organizations |
A list of the logged-in User's Organizations. This could be used to show for which Organization(s) the User works or for which Organization(s) the User has created Offerings. |
| Users | ||
| GET |
Visible Users in your network /{network}/users |
Populate a public listing page of your visible Users. Users are visible if they have their Visibility field set to Open. |
| POST |
Register a new User /{network}/users |
Register a new User. Implement this as part of your registration form, including as much information as you want to collect on the first form. User information can be changed or… |
| GET |
Retrieve a User's public profile information /{network}/users/{userid} |
Populate a user's public profile information. Implement this to allow the logged-in user to see information about other users on the network. It will only populate all… |
| Organizations | ||
| GET |
Retrieve a list of Organizations /{network}/organizations |
A list of visible Organizations in the network. Implement this to show a list of Organizations that are supporting various deals, or that are umbrella entities for various users.… |
| POST |
Create a new Organization /{network}/organizations |
Create a new Organization. |
| DELETE |
Delete the Organization from this network /{network}/organizations/{organizationid} |
Delete the Organization from the network. This will only work if the logged-in User is a team member of the Organization. It will not work if the Organization has any Offerings… |
| GET |
Retrieve information about this Organization /{network}/organizations/{organizationid} |
Information about the Organization. This will only work if the logged-in User is a team member of the Organization or the Organization has visibility set to Open. |
| PATCH |
Update the Organization's information /{network}/organizations/{organizationid} |
Update the Organization's information. This will only work if the logged-in User is a team member of the Organization. |
| GET |
Retrieve Offerings for this Organization /{network}/organizations/{organizationid}/offerings |
A list of visible Offerings for this Organization. Visible Offerings are those with status Restricted, Published, Live, Closing or Settled. |
| POST |
Create a new Offering for this Organization /{network}/organizations/{organizationid}/offerings |
Create a new Offering for this Organization. The logged-in User must be a team member of this Organization. |
| Offerings | ||
| GET |
List of Offerings /{network}/offerings |
Populate a live Offerings page or a historical/closed deals page. Visible Offerings are those with status Restricted, Published, Live, Closing or Settled. |
| DELETE |
Cancel the Offering /{network}/offerings/{offeringid} |
Cancel the Offering. This will only work if the logged-in User is a team member of the Organization for this Offering. It will not work unless the Offering has status as Draft or… |
| GET |
Information about this Offering /{network}/offerings/{offeringid} |
Information about this Offering. This will only work if the Offering is visible in the network. |
| PATCH |
Update the Offering's information /{network}/offerings/{offeringid} |
Update the Offering's information. This will only work if the logged-in User is a team member of the Organization for this Offering and the Offering status is Draft. |
| GET |
List of Investments for this Offering /{network}/offerings/{offeringid}/investments |
Populate a list of Investments for this Offering. This can be used to show a list of current investors for this Offering. Investments will be shown in full if visibility is set… |
| POST |
Submit an Investment /{network}/offerings/{offeringid}/investments |
Submit an Investment for this Offering. This can be used to implement an 'Invest' button on an Offering's page. |
| Investments | ||
| DELETE |
Withdraw this Investment /{network}/investments/{investmentid} |
Withdraw this Investment. The Investment must have been made by the logged-in User. |
| GET |
Information about this Investment /{network}/investments/{investmentid} |
Information about this Investment. It will only work if the Investment has visibility set to Open or Anonymous. |
| PATCH |
Update an Investment /{network}/investments/{investmentid} |
Update this Investment. The Investment must have been made by the logged-in User. |
Crowd Valley pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| PRO Recommended | $1,999 / month | — |
|