- Getting Started
- Real Yeti API V1
- 🏡 Real Estate
- 💵 Private Credit
- 🪙 Stablecoin
Loan by ID
GET
/showcase/loans/{loan_id}
showcase
Request
Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
loan_id
string
required
Header Params
Authorization
string
optional
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://docs.joinclutch.xyz/api/showcase/loans/' \
--header 'Authorization;'
Responses
🟢200Get a loan by loan_id
application/json
Body
allowed_investors
array[string] | null
optional
amortization_type
string | null
optional
available_capacity
string | null
optional
available_capacity_num
number <double> | null
optional
available_capacity_usd
string | null
optional
available_capacity_usd_num
number <double> | null
optional
base_currency
string | null
optional
base_interest_rate
string | null
optional
base_interest_rate_num
number <double> | null
optional
base_interest_rate_type
string | null
optional
countries
array[string] | null
optional
dataroom_url
string | null
optional
day_count_ui
string | null
optional
deal_type
string | null
optional
description
string | null
optional
funding_close_datetime
string | null
optional
funding_close_timestamp
integer <int64> | null
optional
funding_open_datetime
string | null
optional
funding_open_timestamp
integer <int64> | null
optional
id
string
required
idle_capital_amount
string | null
optional
idle_capital_amount_num
number <double> | null
optional
idle_capital_amount_usd
string | null
optional
idle_capital_amount_usd_num
number <double> | null
optional
interest_outstanding_amount
string | null
optional
interest_outstanding_amount_num
number <double> | null
optional
interest_outstanding_amount_usd
string | null
optional
interest_outstanding_amount_usd_num
number <double> | null
optional
interest_total_amount
string | null
optional
interest_total_amount_num
number <double> | null
optional
interest_total_amount_usd
string | null
optional
interest_total_amount_usd_num
number <double> | null
optional
investment_status
string | null
optional
is_investable
boolean | null
optional
issue_price
integer <int32> | null
optional
issuer
null | allOf {1}
optional
object (LoanIssuer)
optional
issuer_id
string | null
optional
late_fee_interest_rate
string | null
optional
late_fee_interest_rate_num
number <double> | null
optional
management_fee
string | null
optional
management_fee_num
number <double> | null
optional
max_capacity
string | null
optional
max_capacity_num
number <double> | null
optional
max_capacity_usd
string | null
optional
max_capacity_usd_num
number <double> | null
optional
month_day_count
integer <int32> | null
optional
name
string | null
optional
originator
null | allOf {1}
optional
object (LoanOriginator)
optional
originator_id
string | null
optional
outstanding_capital_amount
string | null
optional
outstanding_capital_amount_num
number <double> | null
optional
outstanding_capital_amount_usd
string | null
optional
outstanding_capital_amount_usd_num
number <double> | null
optional
payment_frequency_days
integer <int32> | null
optional
performance_fee
string | null
optional
performance_fee_num
number <double> | null
optional
protocol
null | allOf {1}
optional
object (LoanProtocol)
optional
protocol_id
integer <int32> | null
optional
regions
array[string] | null
optional
repayment_status
string | null
optional
reward_currency
string | null
optional
reward_interest_rate
string | null
optional
reward_interest_rate_num
number <double> | null
optional
sectors
array[string] | null
optional
term_days
integer <int32> | null
optional
term_end_datetime
string | null
optional
term_end_timestamp
integer <int64> | null
optional
term_months
number <double> | null
optional
term_start_datetime
string | null
optional
term_start_timestamp
integer <int64> | null
optional
url
string | null
optional
year_day_count
integer <int32> | null
optional
Example
{
"allowed_investors": [
"Accredited",
"Institutional"
],
"amortization_type": "Bullet",
"available_capacity": "$1,000,000",
"available_capacity_num": 1000000,
"available_capacity_usd": "$1,000,000",
"available_capacity_usd_num": 1000000,
"base_currency": "USDC",
"base_interest_rate": "9%",
"base_interest_rate_num": 9,
"base_interest_rate_type": "Fixed",
"countries": [
"Mexico",
"Brazil"
],
"dataroom_url": "https://dataroom.example.com/loan-001",
"day_count_ui": "30/360",
"deal_type": "SME Loan",
"description": "Working capital loan for SMEs in Latin America",
"funding_close_datetime": "2023-08-31T23:59:59Z",
"funding_close_timestamp": 1693526399,
"funding_open_datetime": "2023-07-01T00:00:00Z",
"funding_open_timestamp": 1688169600,
"id": "LOAN-001",
"idle_capital_amount": "$200,000",
"idle_capital_amount_num": 200000,
"idle_capital_amount_usd": "$200,000",
"idle_capital_amount_usd_num": 200000,
"interest_outstanding_amount": "$45,000",
"interest_outstanding_amount_num": 45000,
"interest_outstanding_amount_usd": "$45,000",
"interest_outstanding_amount_usd_num": 45000,
"interest_total_amount": "$90,000",
"interest_total_amount_num": 90000,
"interest_total_amount_usd": "$90,000",
"interest_total_amount_usd_num": 90000,
"investment_status": "Open",
"is_investable": true,
"issue_price": 1,
"issuer": {
"id": "ISSUER-001",
"name": "LatAm Fintech Inc."
},
"issuer_id": "ISSUER-001",
"late_fee_interest_rate": "2%",
"late_fee_interest_rate_num": 2,
"management_fee": "1%",
"management_fee_num": 1,
"max_capacity": "$3,000,000",
"max_capacity_num": 3000000,
"max_capacity_usd": "$3,000,000",
"max_capacity_usd_num": 3000000,
"month_day_count": 30,
"name": "LatAm SME Working Capital Loan",
"originator": {
"id": "ORIG-001",
"name": "LatAm Lender Co."
},
"originator_id": "ORIG-001",
"outstanding_capital_amount": "$1,800,000",
"outstanding_capital_amount_num": 1800000,
"outstanding_capital_amount_usd": "$1,800,000",
"outstanding_capital_amount_usd_num": 1800000,
"payment_frequency_days": 30,
"performance_fee": "10%",
"performance_fee_num": 10,
"protocol": {
"id": 1,
"name": "Goldfinch",
"network": "Ethereum",
"url": "https://goldfinch.finance"
},
"protocol_id": 1,
"regions": [
"Latin America"
],
"repayment_status": "Current",
"reward_currency": "GFI",
"reward_interest_rate": "2%",
"reward_interest_rate_num": 2,
"sectors": [
"SME Lending",
"Working Capital"
],
"term_days": 365,
"term_end_datetime": "2024-08-31T23:59:59Z",
"term_end_timestamp": 1725148799,
"term_months": 12,
"term_start_datetime": "2023-09-01T00:00:00Z",
"term_start_timestamp": 1693526400,
"url": "https://app.goldfinch.finance/loans/LOAN-001",
"year_day_count": 360
}
🟠404Not Found Error
🔴500Error
Modified at 2024-08-27 06:47:34