Lenders

Get lender by ID

GET
/v1/lenders/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Lender canonical-name ID

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/lenders/string"
{
  "data": {
    "canonicalName": "string",
    "displayName": "string",
    "id": "string",
    "totalDocuments": 0
  }
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Count lenders matching filters POST

Return the exact number of lenders matching the given filters. Accepts the same request body as `listLenders` (pagination and sort are ignored). Use this when you only need a total; to get the matching lenders themselves, send the same request body to `listLenders`.

City volume breakdown across this lender's loans POST

Ranks the cities this lender's loans were secured in, by volume. Labels are Title Case so they match the city breakdowns on every other entity.