Grandad, is that you?

Your browser is out of date and doesn't support all of the cool stuff we do on our website.

We like Google Chrome, but any modern browser will do.Update my browser now

×

API documentation

Platform Definition

Defines a single peer-to-peer finance or crowdfunding platform.

Fields

Field Type Description Required (POST)? Example
name
string Platform name Yes None
service_state
string What is the current state of the platform?
Possible values:
Yes live
url
url Platform website URL Yes None
fee_numerical
string Based on a $10000 raise Yes 10000
return_to_funder_numerical
string Yes None
funding_types
object Yes None
loan_classes
object Yes None
platform_countries
object Yes None
languages
object Yes None
project_countries
object Yes None
funder_countries
object Yes None
currencies
object Yes None
payment_options
object Yes None
id
integer No None
white_label
string If true then this is a 'white-label' platform i.e it provides the technology for other people to create their own crowdfunding website. No None
specialism
string Main specialism No e.g "Real Estate"
added
datetime No None
modified
datetime No None
other_payment_option
string No None
funding_terms
string The mode or limitations of raising funds on this platform No all or nothing, or maximum of USD5000
fee_description
string e.g. 5% + transaction fees of 2.9% and USD0.30 No None
return_to_funder
string The return to the funder No None
funder_eligibility
string Funder eligibility No e.g. "Only accredited investors over 18"
project_eligibility
string e.g. Only certified charities with a year of trading No None
regulated_by
string Leave empty if not regulated No None
professional_associations
string Leave empty if not member of a professional association No None
gift_cards
string No None
not_for_profit_platform
string No None
secondary_market
string No None
tax_incentives
string No None

Example

{ "funding_types": [ { "code": "E", "name": "Equity (shares)" } ], "currencies": [ { "code": "USD" } ], "languages": [ { "code": "en", "name": "English" } ], "added": "2014-08-04T15:54:30.126Z", "specialism": "Luxury Hampton Real Estate", "gift_cards": null, "return_to_funder": "", "funder_eligibility": "", "funding_terms": "", "return_to_funder_numerical": "0.00", "modified": "2014-08-04T15:54:30.126Z", "not_for_profit_platform": null, "project_countries": [], "id": 1309, "name": "Funding Hamptons", "url": "http://www.fundinghamptons.com/", "service_state": "live", "secondary_market": null, "regulated_by": "", "project_eligibility": "", "platform_countries": [ { "code": "US", "name": "United States" } ], "fee_description": "", "loan_classes": [], "tax_incentives": null, "fee_numerical": "10000.00", "white_label": false, "payment_options": [], "professional_associations": "", "funder_countries": [], "other_payment_option": "" }