Account

Account related resources

Requires authorization!

API EndpointDescription
GET api/v1/account/balance

Gets your account balance information

Requires authorization!

Response Codes

  • 200 - Successfully got info of your balance
  • 401 - User is not Authorized

GET api/v1/account/investments

Gets list of your investments

Requires authorization!

Requires scope Investments

Response Codes

  • 200 - Successfully got list of your investments
  • 401 - User is not Authorized

GET api/v1/eventlog

Gets events that have been made with this application (related to current access token)

Requires authorization!

Response Codes

  • 200 - Successfully got list of events
  • 401 - User is not Authorized

OAuth

OAuth 2.0 Token management

API EndpointDescription
POST oauth/access_token

Redeem access token for code

Response Codes

  • 200 - Successfully generated the access token
  • 400 - Missing or invalid parameters or something else wrong with the request.

POST oauth/access_token/revoke

Revoke authorization token. Call to the endpoint revokes the same Token that the request is using

Requires authorization!

Response Codes

  • 202 - Successfully accepted
  • 401 - User is not Authorized

Bid

Make bids into Auction(s) or get list of Bid(s) made.

Requires authorization!

API EndpointDescription
GET api/v1/bids

Gets list of bids the investor has made.

Requires authorization!

Requires scope BidsRead

Response Codes

  • 200 - Successfully got list of user's bids
  • 401 - User is not Authorized

POST api/v1/bid

Makes bid(s) into specified auction(s).

Requires authorization!

Requires scope BidsEdit

Response Codes

  • 202 - Successfully accepted the bid(s). It may take some time until the bid requests are created. It will take more time until the actual bid(s) are made for the Auction(s).
  • 400 - No bids specified
  • 400 - Too many items. Max items 100
  • 401 - User is not Authorized
  • 404 - Auction with specified ID is not found

GET api/v1/bid/{id}

Get the Bid

Requires authorization!

Requires scope BidsRead

Response Codes

  • 200 - Successfully fetched the Bid
  • 400 - No Bid id specified
  • 401 - User is not Authorized
  • 403 - Not allowed to get the Bid, because the bid is not owned by current user
  • 404 - Bid with specified ID is not found

POST api/v1/bid/{id}/cancel

Cancel the Bid

Requires authorization!

Requires scope BidsEdit

Response Codes

  • 202 - Successfully accepted the cancellation request for the Bid
  • 400 - No Bid id specified
  • 401 - User is not Authorized
  • 403 - The user has no rights to cancel the Bid
  • 404 - Bid with specified ID is not found
  • 409 - Can not cancel Bid.

Report

Report related resources

Requires authorization!

API EndpointDescription
GET api/v1/loandataset

Provides daily dataset of all loan data that is not covered by the data protection laws.

Requires authorization!

This action is Obsolete: Please use api/v1/publicdataset instead

Response Codes

  • 200 - Successfully got list of loan dataset items
  • 401 - User is not Authorized

GET api/v1/publicdataset

Provides daily public dataset of all loan data that is not covered by the data protection laws.

Requires authorization!

Response Codes

  • 200 - Successfully got list of loan public dataset items
  • 401 - User is not Authorized

GET api/v1/reports

List of all reports

Requires authorization!

Requires scope ReportRead

Response Codes

  • 200 - Successfully got report list
  • 401 - User is not Authorized

GET api/v1/report/{id}

Get report data for specified report identificator.

Requires authorization!

Requires scope ReportRead

Response Codes

  • 200 - Successfully got report data
  • 401 - User is not Authorized
  • 403 - Not allowed to get the Report, because the Report is not owned by current user
  • 404 - Report with specified identificator was not found
  • 409 - Report type is not supported

POST api/v1/report

Request to generate specified report type for set period.

Requires authorization!

Requires scope ReportCreate

Response Codes

  • 202 - Successfully accepted request. It may take some time until the reports are created.
  • 400 - Report type is not supported
  • 400 - PeriodStart or PeriodEnd is empty
  • 400 - PeriodStart is too small (less than 2009-01-01)
  • 400 - PeriodEnd is too large (more than 20 years from today)
  • 401 - User is not Authorized

Auction

Auction related resources

Requires authorization!

API EndpointDescription
GET api/v1/auctions

Gets list of active Auctions

Requires authorization!

Response Codes

  • 200 - Successfully got list of auctions
  • 401 - User is not Authorized

GET api/v1/auction/{id}

Gets Auction info by auction identifier

Requires authorization!

Response Codes

  • 200 - Successfully got Auction with specified ID
  • 400 - Auction ID is not provided
  • 401 - User is not Authorized
  • 404 - Auction with the provided ID was not found

SecondMarket

SecondMarket related resources

Requires authorization!

API EndpointDescription
GET api/v1/secondarymarket

Gets list of active secondary market items

Requires authorization!

Response Codes

  • 200 - Successfully got list of secondary market items
  • 401 - User is not Authorized

GET api/v1/loanpart/{id}

Gets LoanPartDetails info by identifier

Requires authorization!

Response Codes

  • 200 - Successfully got LoanPartDetails with specified ID
  • 400 - LoanPart ID is not provided
  • 401 - User is not Authorized
  • 404 - LoanPart with the provided ID was not found

POST api/v1/secondarymarket/buy

Buy loans from secondary market.

Requires authorization!

Requires scope SmBuy

Response Codes

  • 202 - Successfully accepted buy request.
  • 400 - No items specified
  • 400 - Too many items. Max items 100
  • 401 - User is not Authorized
  • 403 - User has no rights
  • 404 - Not found
  • 409 - Investment cannot be bought

POST api/v1/secondarymarket/sell

Sell your loans to secondary market.

Requires authorization!

Requires scope SmSell

Response Codes

  • 202 - Successfully accepted sell request.
  • 400 - No items specified
  • 400 - Too many items. Max items 100
  • 401 - User is not Authorized
  • 403 - User has no rights
  • 404 - Not found
  • 409 - Investment cannot be sold

POST api/v1/secondarymarket/{id}/cancel

Remove your loans from secondary market.

Requires authorization!

Requires scope SmSell

Response Codes

  • 202 - Successfully accepted cancel request.
  • 400 - Not found
  • 401 - User is not Authorized
  • 403 - User has no rights
  • 409 - Cannot cancel item

POST api/v1/secondarymarket/cancel

Remove your loans from secondary market.

Requires authorization!

Requires scope SmSell

Response Codes

  • 202 - Successfully accepted cancel request.
  • 400 - No items specified
  • 400 - Too many items. Max items 100
  • 401 - User is not Authorized
  • 403 - User has no rights
  • 409 - Cannot cancel item

GET api/v1/secondarymarket/{id}

Get the secondary market item summary

Requires authorization!

Response Codes

  • 200 - Successfully fetched the SecondaryMarket item
  • 400 - No id specified
  • 401 - User is not Authorized
  • 404 - SecondaryMarket item with specified ID is not found