API documentation

Loan Project Definition

We use this data structure to define an individual peer-to-peer loan.

As a fallback for fields which just don't fit into the schema but which may be of use we provide a JSON field extra.


Field Type Description Required (POST)? Example
project_id string A unique identifier for this project set by the originating platform. Yes e.g "1234"
integer This is the our ID we use to identify the originating platform, and can be found on the platform detail page. Yes e.g "443"
funding_type string The funding type for this project. Yes e.g "R" (for a Rewards-based project)
predicted_gics_industry_group string Class name taken from our chosen taxonomy. We are currently using the GICS industry groups. No e.g "Transportation"
title string Project title, or a short (one-line) description or summary. Yes e.g "My New Widget"
status string

Current project status. Optional, as we can calculate this field for posted projects.

Possible values:

Ongoing project
Cancelled project
Project has reached its goal and ended
Project has reached its goal and is ongoing
Project has failed to reach its goal and ended
No e.g "successful_ended"
live boolean Is this project still live? No e.g "true"
currency string Currency code Yes e.g "USD"
url URL Main URL for project, if any No e.g "http://www.insidetab.io"
category string Project category No e.g "Technology"
project_thumbnail_url URL Small image that represents this project. No e.g "http://www.my-favourite-image.png"
description string A detailed description of the project where appropriate No e.g "The most incredible widget ever designed, made entirely from recycled spatulas."
uuid string This is generated by TAB using the platform identifier and any other platform-specific identifiers (such as the platform_id) to provide a globally unique identifier across all platforms. No e.g "b4df7b093b9b33fbbc11be54bf8355cb"
funders integer The total number of funders contributing to this project. No e.g 56
subtitle string Project subtitle, describing the project in more detail. No e.g 'A completely new way to create widgets'
language string Primary language used. We use the standard set of ISO language codes No e.g "fr"
location object

Project location, where appropriate. We describe locations as a JSON dictionary - see here for more detail.

Note that only the address field is mandatory: we can work out the latitude and longitude for inserted projects if the address is valid

No e.g
{"address": "Salisbury House, Cambridge, UK"}
start_time date/time Start date/time for this project. No e.g "2014-09-01T14:22Z"
end_time date/time End date/time for this project. Defaults to open-ended No e.g "2014-10-01T14:22Z"
date_added date/time When did TAB first add this project to our database? No e.g "2014-09-01T12:34Z
last_updated date/time When did TAB last update this project? No e.g "2014-10-01T18:34Z
tags string List of tags No e.g ["social, technology"]
tax_relief string List of applicable tax relief schemes No e.g ["SEIS"]
owner_details object Project owner. Users are described by a JSON dictionary described here in more detail.

Note that all the user fields are optional, although at least one should be specified if this field is set.

No e.g
{ "id": 1234, "full_name":"Mister Happy" }
team_members_list JSON list Project team members as a JSON list. See owner_details for a description of the owner dictionary No e.g
[ {"id": 1234, "full_name":"Mister Tickle" }, {"id": 1235, "full_name":"Mister Grumpy" } ]
company_details object Associated company description, if applicable. We describe an organisation as a JSON dictionary - see here for more detail. No e.g {"name":"MechanicalMouseOrganCo"}
transactions JSON list JSON list of transactions, if applicable No
facebook_url url URL to associated Facebook page No
twitter_url url URL to associated Twitter page No
goal numeric The project goal, in the specified currency. No e.g "1000000"
raised numeric Total amount raised to date, in the specified currency. No e.g "110000"
extra JSON Extra information that may be of use but does not fit into the current schema. No e.g
{ "some_field": "foobar value", "another_field": 999 }
APR percentage The loan APR, if available Yes e.g 14.3 term_months integer Length of term, in months Yes e.g 60 interest_rate percentage Interest rate offered by the loan No e.g 8.5 secured_loan boolean Is this loan secured? No e.g No individual_loan boolean Is this an individual loan (No implies business loan)? No e.g true loan_fee numeric Loan arrangement fee No e.g 142 LTV percentage Loan To Value figure, if appropriate No e.g 80 aftermarket boolean Is this an aftermarket loan? Defaults to no. No e.g yes risk_category string An indication of the risk category for this loan e.g A No e.g A


{ "platform_name": "RateSetter", "interest_rate": 2.6, "APR": 28.6, "title": "6 Month Loan", "last_updated": "2014-06-11T00:00:00", "uuid": "ba20e65f5504a311f98a007a1a28d6db", "location": { "address": "London, UK" }, "term_months": 6, "description": "Representative example: If you borrow \u00a331,000 over 6 months at a Representative APR of 28.6% fixed, arrangement fees of \u00a3362.10 and an annual interest rate of 2.6% you would pay", "category": "Fixed", "platform_id": 4, "currency": "GBP", "funding_type": "L", "loan_fee": 62.1 }