The lenders active in a place, and one lender’s profile, loans and borrowers.
List the lenders active in a place
Cost: $1.00 per list · desks only
Returns the lenders of a state, a county or a list of ZIP codes, ranked.
Where. Send the two-letter state; the data service requires it. Narrow it with a county, or send a list of ZIP codes (zip).
This is a Metered Call. If the data service rejects the request, answers that what it names does not exist, fails or does not answer in time, the charge is returned to the Account as a Refund. An empty answer for a place inside the data’s coverage is an answer, and it is charged.
Coverage. A place outside the data’s coverage is refused before anything is charged; the docs page states where the data covers. When the place a request names cannot be checked against the coverage and the answer is empty, the call answers 422 property-not-found and its charge is returned.
query Parameters
stateThe two-letter state code of the place. Required. The data service checks this value: one it refuses is answered 400 upstream-rejected-request, and the charge comes back as a Refund.
countyA county of the state, to narrow the lenders to it. The data service checks this value: one it refuses is answered 400 upstream-rejected-request, and the charge comes back as a Refund.
zipFive-digit ZIP codes, comma-separated or as repeated zip parameters.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Idempotency-KeyAn opaque string of your choosing that makes retrying this request safe. Optional — a request without one is never an error, and is charged per call. Reusing a key with the same request — the same path and the same query string — within 24 hours returns the stored result and is not charged again, but only when the earlier call succeeded and its response was stored. If the earlier call was refunded or ended without a stored response, the key is taken over: the new request runs and is charged. Otherwise reusing a key with a different request, or on another endpoint, is refused as a conflict, and nothing is charged for it. If an identical request carrying the same key is still in flight, this one waits briefly for that result; if it does not arrive, the response is 409 with a Retry-After header and nothing is consumed for it. Keys are scoped to your Account — one Account never replays another Account’s result.
X-Customer-Reference^[A-Za-z0-9._:-]{1,6…Optional. Your own ID for the customer this call is for — an ID, not a name or email. Shown back to you grouped by customer on the Usage page.
List the lenders active in a place › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer, and it is charged.
Read a lender’s profile
Cost: $0.50 per lender · desks only
Returns one lender: its loan counts, its open book, the spread of its loan amounts, rates and terms, and the places it lends in.
This is a Metered Call. If the data service rejects the request, finds no such lender, fails or does not answer in time, the charge is returned to the Account as a Refund.
path Parameters
lender_idThe data service’s own identifier for one lender: a two-letter state code, a colon, then a registry number or a name key. Percent-encode it in the path, so each colon is sent as %3A. An identifier in any other form is refused before anything is charged.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Idempotency-KeyAn opaque string of your choosing that makes retrying this request safe. Optional — a request without one is never an error, and is charged per call. Reusing a key with the same request — the same path and the same query string — within 24 hours returns the stored result and is not charged again, but only when the earlier call succeeded and its response was stored. If the earlier call was refunded or ended without a stored response, the key is taken over: the new request runs and is charged. Otherwise reusing a key with a different request, or on another endpoint, is refused as a conflict, and nothing is charged for it. If an identical request carrying the same key is still in flight, this one waits briefly for that result; if it does not arrive, the response is 409 with a Retry-After header and nothing is consumed for it. Keys are scoped to your Account — one Account never replays another Account’s result.
X-Customer-Reference^[A-Za-z0-9._:-]{1,6…Optional. Your own ID for the customer this call is for — an ID, not a name or email. Shown back to you grouped by customer on the Usage page.
Read a lender’s profile › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer, and it is charged.
List a lender’s loans
Cost: $0.50 per page · desks only
Returns one lender’s loans, newest first.
This is a Metered Call. If the data service rejects the request, finds no such lender, fails or does not answer in time, the charge is returned to the Account as a Refund.
path Parameters
lender_idThe data service’s own identifier for one lender: a two-letter state code, a colon, then a registry number or a name key. Percent-encode it in the path, so each colon is sent as %3A. An identifier in any other form is refused before anything is charged.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Idempotency-KeyAn opaque string of your choosing that makes retrying this request safe. Optional — a request without one is never an error, and is charged per call. Reusing a key with the same request — the same path and the same query string — within 24 hours returns the stored result and is not charged again, but only when the earlier call succeeded and its response was stored. If the earlier call was refunded or ended without a stored response, the key is taken over: the new request runs and is charged. Otherwise reusing a key with a different request, or on another endpoint, is refused as a conflict, and nothing is charged for it. If an identical request carrying the same key is still in flight, this one waits briefly for that result; if it does not arrive, the response is 409 with a Retry-After header and nothing is consumed for it. Keys are scoped to your Account — one Account never replays another Account’s result.
X-Customer-Reference^[A-Za-z0-9._:-]{1,6…Optional. Your own ID for the customer this call is for — an ID, not a name or email. Shown back to you grouped by customer on the Usage page.
List a lender’s loans › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer, and it is charged.
List who a lender lends to
Cost: $0.50 per page · desks only
Returns one lender’s borrowers, as companies.
This is a Metered Call. If the data service rejects the request, finds no such lender, fails or does not answer in time, the charge is returned to the Account as a Refund.
path Parameters
lender_idThe data service’s own identifier for one lender: a two-letter state code, a colon, then a registry number or a name key. Percent-encode it in the path, so each colon is sent as %3A. An identifier in any other form is refused before anything is charged.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Idempotency-KeyAn opaque string of your choosing that makes retrying this request safe. Optional — a request without one is never an error, and is charged per call. Reusing a key with the same request — the same path and the same query string — within 24 hours returns the stored result and is not charged again, but only when the earlier call succeeded and its response was stored. If the earlier call was refunded or ended without a stored response, the key is taken over: the new request runs and is charged. Otherwise reusing a key with a different request, or on another endpoint, is refused as a conflict, and nothing is charged for it. If an identical request carrying the same key is still in flight, this one waits briefly for that result; if it does not arrive, the response is 409 with a Retry-After header and nothing is consumed for it. Keys are scoped to your Account — one Account never replays another Account’s result.
X-Customer-Reference^[A-Za-z0-9._:-]{1,6…Optional. Your own ID for the customer this call is for — an ID, not a name or email. Shown back to you grouped by customer on the Usage page.
List who a lender lends to › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer, and it is charged.