Search for all loans available at primary and secondary marketplace. The service shall return either all loans currently available.

Search for all loans/microloans available for auction.
The service shall return either all loans and/or microloans currently available.

  • When using apikey, endpoint will not try to look for authorization header.
  • When using authorization header, bearer token should be of type client_credentials.
  • To calculate your_existing_exposure MARKETPLACE and MICROLOANS filters require apikey + userkey or password-type access_token for authorization, otherwise your_existing_exposure = 0
  • Filter = MYLOANS require apikey + userkey or password-type access_token authorization

Description

Definition: Search for all loans available for auction.

Parameters

ParameterDefinition
loan_idThe id of the loan. If no id is supplied then all loans are returned.
detailThe level of detail of the information returned.
filterFilter returned loans/microloans.
apikeyAPI access key supplied by Rebuilding Society.
userkeyToken for User Authentication see Userkey
offsetOffset for the loans
limitLimit loans number

Filter parameter description:

ParameterDescription
MYLOANSReturn all loans for the user identified by api_key. Require apikey + userkey or password-type access_token
APPROVEDReturn all loans with the status does begin with "Approved%".
CLOSEDReturn all loans with status does begin with "Fu%" . This include statuses: “Funded%”,”Fully repaid”.
ALLReturns all the loans, except loans with status:” Rejected”,” Pending review”.
MARKETPLACEReturns all the loans (except with status:” Rejected”, ”Pending review”) at primary and secondary marketplace.
MICROLOANSReturns only secondary marketplace loans
Language
Click Try It! to start a request and see the response here!