{"openapi":"3.1.0","info":{"title":"The Lender Report API","version":"2.0.0","summary":"Who has made loans like this one, from public filings.","description":"US lender records from FDIC call reports, NCUA 5300 filings, HMDA and SBA data. Read only. It works with no account and no key, within the limits at https://lender.report/developers/#limits.\n\nEvery record carries source, as_of, cite_as and license. Every answer carries data_version, cite, license and limits, and says what it cannot tell you in what_we_dont_know and do_not_claim.\n\nlisting_state is one of unverified, claimed or verified. It describes the listing, never the lender. Verified is a paid listing. Order is not affected by payment. It is read after the order of a result is final. unverified: Built from public records. The lender has not reviewed the page. Every lender starts this way, and it says nothing about the lender itself. Claiming is free. claimed: A representative of the lender proved they act for it, with a work email address at the lender's own domain or another accepted proof (a DNS record on that domain, a call to the main number, a signed letter from an officer, or a review of a non-bank's records). They can correct facts. Claiming is free. The lending details have not been confirmed. verified: The lender pays a flat monthly fee for the listing and confirmed its lending details on a stated date. It is not a rating or an opinion of the lender. Paying never changes where a lender appears in search, lists or rankings.\n\nNo route sends a message or a financing request for anyone. A person who wants to ask for financing fills in the form at https://lender.report/request-financing/. Who receives this: JPro Labs LLC, the company that operates The Lender Report. It is not sent to any lender.\n\nErrors are problem details (RFC 9457). Each type is explained at https://lender.report/errors/. The same tools are an MCP server at https://lender.report/mcp.\n\nThe Lender Report is operated by JPro Labs LLC.","contact":{"name":"The Lender Report desk","email":"desk@lender.report","url":"https://lender.report/developers/"},"license":{"name":"The Lender Report license","url":"https://lender.report/license/"},"termsOfService":"https://lender.report/terms/"},"externalDocs":{"description":"Developer docs: setup, limits, versioning and markdown","url":"https://lender.report/developers/"},"servers":[{"url":"https://lender.report/api/v1","description":"Production"}],"tags":[{"name":"Lenders","description":"Lender records and loan comps"},{"name":"Service","description":"Coverage, releases and health"}],"security":[{},{"key":[]}],"paths":{"/meta":{"get":{"operationId":"get_coverage","summary":"Get coverage, dates and limits","description":"Returns what the record covers and how current it is: counts, the as-of date of each source, the data release id, known limits, the ranking metrics with their scopes, the license and the citation format. Use it before relying on the data, or to answer \"how current is this\".","tags":["Service"],"parameters":[],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_coverage_result"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/coverage":{"get":{"operationId":"get_coverage_alias","summary":"Get coverage, dates and limits (same answer as /meta)","description":"Returns what the record covers and how current it is: counts, the as-of date of each source, the data release id, known limits, the ranking metrics with their scopes, the license and the citation format. Use it before relying on the data, or to answer \"how current is this\".","tags":["Service"],"parameters":[],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_coverage_result"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/comps":{"get":{"operationId":"find_loan_comps","summary":"Find lenders that made loans like this","description":"Returns lenders with public evidence of loans like a described deal, in three groups (banks and credit unions with an office in the state, those without, non-banks). Each row has the evidence level, counts, a sentence with its source, and the recorded loans in the place asked. Use it for \"who has made a loan like this\". Give lane and state, plus amount and purpose; use resolve_place first for a city or county. It reports past loans, not who is lending today. For one named lender use get_lender.","tags":["Lenders"],"parameters":[{"name":"lane","in":"query","required":true,"description":"Kind of loan","schema":{"type":"string","enum":["multifamily","investor_1to4","cre_investor","cre_owner","construction","residential_development","farmland","business","sba_7a","sba_504"]}},{"name":"state","in":"query","required":false,"description":"State of the property or business: two letters (OH) or the name (Ohio). Required unless place, metro or county names one.","schema":{"type":"string"}},{"name":"place","in":"query","required":false,"description":"A city, county or metro in plain words, for example \"Columbus, OH\" or \"Franklin County, OH\". Resolved on the server; if the name is ambiguous the answer lists the assumption and the alternatives.","schema":{"type":"string"}},{"name":"amount","in":"query","required":false,"description":"Loan amount in whole dollars, for example 2400000","schema":{"type":"number"}},{"name":"purpose","in":"query","required":false,"description":"What the loan is for. Only HMDA rows can check this; other lanes say so in answerable.","schema":{"type":"string","enum":["purchase","refinance","cash_out","improvement","construction","working_capital","equipment","bridge"]}},{"name":"type","in":"query","required":false,"description":"Property type. SBA lanes: an industry word (restaurants, hotels, dental practices) or a NAICS code of 2 to 6 digits","schema":{"type":"string"}},{"name":"units","in":"query","required":false,"description":"Number of units, or a band: 5-24, 25-49, 50-99, 100-149, >149","schema":{"type":"string"}},{"name":"county","in":"query","required":false,"description":"County name (Franklin County) or 5-digit FIPS","schema":{"type":"string"}},{"name":"metro","in":"query","required":false,"description":"5-digit Census CBSA code","schema":{"type":"string"}},{"name":"program","in":"query","required":false,"description":"Program","schema":{"type":"string","enum":["any","conventional","sba_7a","sba_504"]}},{"name":"lender_kind","in":"query","required":false,"description":"Kind of lender","schema":{"type":"string","enum":["any","bank","credit_union","non_bank"]}},{"name":"ltv","in":"query","required":false,"description":"Optional loan to value, 1 to 100. Only marks which loans were at similar leverage.","schema":{"type":"number"}},{"name":"include_elsewhere","in":"query","required":false,"description":"Also list lenders showing only a slight sign (level elsewhere). Default false.","schema":{"type":"boolean"}},{"name":"include_ruled_out","in":"query","required":false,"description":"Also list lenders that merged or stopped filing and why. Default false.","schema":{"type":"boolean"}},{"name":"detail","in":"query","required":false,"description":"How much to return. brief (default) is enough to answer; standard adds the loans recorded for each lender and contact details; full adds everything the record holds. Larger answers cost more of the caller's context.","schema":{"type":"string","enum":["brief","standard","full"],"default":"brief"}},{"name":"limit","in":"query","required":false,"description":"Rows to return, 1 to 10. Default 6 for find_loan_comps and 10 elsewhere. The result says when fewer were allowed.","schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging.","schema":{"type":"integer","minimum":0}},{"name":"q","in":"query","required":false,"description":"The deal in one sentence, read by the same parser as the site. Nothing sensitive: names, Social Security numbers, tax IDs, credit scores, income, revenue and account numbers are refused.","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/find_loan_comps_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"More than one lender or place fits. The body lists the candidates. Repeat the call with one of them.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"find_loan_comps_json","summary":"Find lenders that made loans like this (deal in a JSON body)","description":"The same read as GET /comps. Nothing is stored and nothing is sent to a lender.","tags":["Lenders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"lane":{"type":"string","description":"Kind of loan","enum":["multifamily","investor_1to4","cre_investor","cre_owner","construction","residential_development","farmland","business","sba_7a","sba_504"]},"state":{"type":"string","description":"State of the property or business: two letters (OH) or the name (Ohio). Required unless place, metro or county names one."},"place":{"type":"string","description":"A city, county or metro in plain words, for example \"Columbus, OH\" or \"Franklin County, OH\". Resolved on the server; if the name is ambiguous the answer lists the assumption and the alternatives."},"amount":{"type":"number","description":"Loan amount in whole dollars, for example 2400000"},"purpose":{"type":"string","description":"What the loan is for. Only HMDA rows can check this; other lanes say so in answerable.","enum":["purchase","refinance","cash_out","improvement","construction","working_capital","equipment","bridge"]},"type":{"type":"string","description":"Property type. SBA lanes: an industry word (restaurants, hotels, dental practices) or a NAICS code of 2 to 6 digits"},"units":{"type":"string","description":"Number of units, or a band: 5-24, 25-49, 50-99, 100-149, >149"},"county":{"type":"string","description":"County name (Franklin County) or 5-digit FIPS"},"metro":{"type":"string","description":"5-digit Census CBSA code"},"program":{"type":"string","description":"Program","enum":["any","conventional","sba_7a","sba_504"]},"lender_kind":{"type":"string","description":"Kind of lender","enum":["any","bank","credit_union","non_bank"]},"ltv":{"type":"number","description":"Optional loan to value, 1 to 100. Only marks which loans were at similar leverage."},"include_elsewhere":{"type":"boolean","description":"Also list lenders showing only a slight sign (level elsewhere). Default false."},"include_ruled_out":{"type":"boolean","description":"Also list lenders that merged or stopped filing and why. Default false."},"detail":{"type":"string","description":"How much to return. brief (default) is enough to answer; standard adds the loans recorded for each lender and contact details; full adds everything the record holds. Larger answers cost more of the caller's context.","enum":["brief","standard","full"],"default":"brief"},"limit":{"type":"integer","description":"Rows to return, 1 to 10. Default 6 for find_loan_comps and 10 elsewhere. The result says when fewer were allowed.","minimum":1,"maximum":10},"offset":{"type":"integer","description":"Rows to skip, for paging.","minimum":0}},"required":["lane"],"additionalProperties":false}}}},"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/find_loan_comps_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"More than one lender or place fits. The body lists the candidates. Repeat the call with one of them.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/lenders":{"get":{"operationId":"search_lenders","summary":"Search lenders","description":"Finds lenders by name, trade name or holding company, or lists them by state, kind, asset size and flags, with identifiers, books held by category and counts of loans made. Use it to get a lender identifier or to build a list, such as credit unions in a state that bought participations. For deal evidence use find_loan_comps; for \"is it still operating\" use check_lender_status.","tags":["Lenders"],"parameters":[{"name":"q","in":"query","required":false,"description":"Lender name, trade name or holding company","schema":{"type":"string"}},{"name":"office_state","in":"query","required":false,"description":"Has an office in this state (two letters). The old name for this field, state, still works.","schema":{"type":"string"}},{"name":"hq_state","in":"query","required":false,"description":"Headquartered in this state (two letters)","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Kind of lender","schema":{"type":"string","enum":["bank","savings","credit_union","nonbank"]}},{"name":"flags","in":"query","required":false,"description":"All must be true. participations_bought_or_held means the lender bought commercial participations in the first half of 2026 or holds nonmember commercial loans and participations; the amounts are in each row.","schema":{"type":"array","items":{"type":"string","enum":["multifamily","construction","investor_cre","small_balance_cre","investor_1to4","sba","participations_bought_or_held","growing_cre"]}},"style":"form","explode":false},{"name":"min_assets","in":"query","required":false,"description":"Minimum total assets in dollars","schema":{"type":"number"}},{"name":"max_assets","in":"query","required":false,"description":"Maximum total assets in dollars","schema":{"type":"number"}},{"name":"min_participations_bought","in":"query","required":false,"description":"Minimum dollars of commercial participations bought January 1 to June 30, 2026 (credit unions)","schema":{"type":"number"}},{"name":"sort","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["commercial_total","assets","name","multifamily_book","construction_book","owner_occupied_book","non_owner_occupied_book","business_book","farmland_book","multifamily_loans","sba_7a_loans","sba_504_loans","participations_bought"]}},{"name":"detail","in":"query","required":false,"description":"How much to return. brief (default) is enough to answer; standard adds the book by category and loans made by program; full adds everything the record holds. Larger answers cost more of the caller's context.","schema":{"type":"string","enum":["brief","standard","full"],"default":"brief"}},{"name":"limit","in":"query","required":false,"description":"Rows to return, 1 to 10. Default 6 for find_loan_comps and 10 elsewhere. The result says when fewer were allowed.","schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging.","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_lenders_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/lenders/{id}":{"get":{"operationId":"get_lender","summary":"Get one lender","description":"Returns one lender by slug or identifier (fdic:6653, ncua:21930, rssd:489623, lei:...): identity, status, books held by category, loans made by program, offices, capacity measures (not a rating), dated one-sentence facts and a citation. The default view is a summary; ask for book, activity, capacity, signals, peers or facts for the rest. For its recent loans use get_lender_activity.","tags":["Lenders"],"parameters":[{"name":"id","in":"path","required":true,"description":"A lender: its slug from a page URL, or an identifier such as fdic:6653, ncua:21930, rssd:489623 or lei:549300CEHN5CVC6INV48","schema":{"type":"string"}},{"name":"view","in":"query","required":false,"description":"Part of the record. summary (default) is identity, status, totals, loans made, offices, flags and six facts.","schema":{"type":"string","enum":["summary","book","activity","capacity","signals","peers","facts","history","full"],"default":"summary"}},{"name":"as_of","in":"query","required":false,"description":"YYYY-MM-DD, a quarter end: the balances the lender reported for that quarter, from the twelve quarters held. The latest quarter needs no account; earlier ones are history.","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_lender_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"This depth needs a free account or a key. The body says which.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"More than one lender or place fits. The body lists the candidates. Repeat the call with one of them.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/lenders/{id}/status":{"get":{"operationId":"check_lender_status","summary":"Check whether a lender is still operating","description":"Returns whether a bank or credit union is operating, merged, closed or not in this record, with the regulator's date, any successor, and a link to the regulator's own record. Accepts an identifier or a name. Use it for \"is this lender still in business\". It states what records say; it is not a statement about safety or soundness, and a lender not found may still exist.","tags":["Lenders"],"parameters":[{"name":"id","in":"path","required":true,"description":"A lender: its slug from a page URL, or an identifier such as fdic:6653, ncua:21930, rssd:489623 or lei:549300CEHN5CVC6INV48","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"A lender name, if no identifier is known","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"Two-letter state, to separate lenders with the same name","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/check_lender_status_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"More than one lender or place fits. The body lists the candidates. Repeat the call with one of them.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/lenders/{id}/activity":{"get":{"operationId":"get_lender_activity","summary":"Get what one lender has made","description":"Returns the loans one lender has made, from HMDA, SBA and credit union filings, as counts, medians and coarsened recent loans, optionally for one state, metro and program. No borrower names. Use it after get_lender to see what the lender has actually closed. A held balance is not evidence of a recent loan.","tags":["Lenders"],"parameters":[{"name":"id","in":"path","required":true,"description":"A lender: its slug from a page URL, or an identifier such as fdic:6653, ncua:21930, rssd:489623 or lei:549300CEHN5CVC6INV48","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"Two-letter state","schema":{"type":"string"}},{"name":"metro","in":"query","required":false,"description":"5-digit Census CBSA code","schema":{"type":"string"}},{"name":"program","in":"query","required":false,"description":"Program","schema":{"type":"string","enum":["hmda_mf","sba_7a","sba_504"]}},{"name":"period","in":"query","required":false,"description":"HMDA year (2025, 2024) or SBA window: latest, 12m, 24m, 36m","schema":{"type":"string"}},{"name":"detail","in":"query","required":false,"description":"How much to return. brief (default) is enough to answer; standard adds more recent loans; full adds everything the record holds. Larger answers cost more of the caller's context.","schema":{"type":"string","enum":["brief","standard","full"],"default":"brief"}},{"name":"limit","in":"query","required":false,"description":"Rows to return, 1 to 10. Default 6 for find_loan_comps and 10 elsewhere. The result says when fewer were allowed.","schema":{"type":"integer","minimum":1,"maximum":10}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_lender_activity_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/lenders/{id}/history":{"get":{"operationId":"get_lender_history","summary":"Quarterly book history from call reports","description":"The same answer as /lenders/{id} with the book by quarter. Needs a free account or a key.","tags":["Lenders"],"parameters":[{"name":"id","in":"path","required":true,"description":"A lender: its slug from a page URL, or an identifier such as fdic:6653, ncua:21930, rssd:489623 or lei:549300CEHN5CVC6INV48","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_lender_result"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"This depth needs a free account or a key. The body says which.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"More than one lender or place fits. The body lists the candidates. Repeat the call with one of them.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/places":{"get":{"operationId":"resolve_place","summary":"Resolve a place name to codes","description":"Turns a city, county, metro or state name into the place codes the other tools take, with every plausible candidate when a name is ambiguous (Columbus in Ohio, Georgia and Indiana). Use it before find_loan_comps or list_market_lenders when the user names a place. Returns CBSA codes, county FIPS codes, state codes and, where it exists, the page for that place.","tags":["Lenders"],"parameters":[{"name":"q","in":"query","required":true,"description":"A city, county, metro or state name, with the state if the user gave one, for example \"Columbus\" or \"Franklin County, OH\"","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"Two-letter state, to narrow the candidates","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Candidates to return, 1 to 10. Default 5.","schema":{"type":"integer","minimum":1,"maximum":10}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resolve_place_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"More than one lender or place fits. The body lists the candidates. Repeat the call with one of them.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/markets/{place}":{"get":{"operationId":"list_market_lenders","summary":"List lenders active in a place","description":"Returns who has recorded loans in a state or metro for one lane, ordered by count, with totals. Where a lane has no loan-level record (commercial real estate at banks, construction, farmland, business) it lists lenders with an office in the state that hold that kind of book, and says so. Use it for \"who lends in Columbus\"; accepts a place name, a state or a CBSA code.","tags":["Lenders"],"parameters":[{"name":"place","in":"path","required":true,"description":"A place name (\"Columbus, OH\"), a two-letter state or a 5-digit CBSA code","schema":{"type":"string"}},{"name":"lane","in":"query","required":false,"description":"Kind of loan","schema":{"type":"string","enum":["multifamily","investor_1to4","cre_investor","cre_owner","construction","residential_development","farmland","business","sba_7a","sba_504"]}},{"name":"program","in":"query","required":false,"description":"Program","schema":{"type":"string","enum":["any","conventional","sba_7a","sba_504"]}},{"name":"detail","in":"query","required":false,"description":"How much to return. brief (default) is enough to answer; standard adds the book by category; full adds everything the record holds. Larger answers cost more of the caller's context.","schema":{"type":"string","enum":["brief","standard","full"],"default":"brief"}},{"name":"limit","in":"query","required":false,"description":"Rows to return, 1 to 10. Default 6 for find_loan_comps and 10 elsewhere. The result says when fewer were allowed.","schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging.","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_market_lenders_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/rankings/{metric}":{"get":{"operationId":"rank_lenders","summary":"Rank lenders on one defined measure","description":"Returns one ranking on one defined measure, period and source, national or for one state, with the unit stated and the address of its ranking page. Rankings cover lending activity and books held only. Use it for \"largest SBA 7(a) lenders in Texas\" or \"credit unions that bought the most participations\". get_coverage lists each metric with the scopes it has.","tags":["Lenders"],"parameters":[{"name":"metric","in":"path","required":true,"description":"Measure. The unit is in the name: _loans_made and _projects count loans, _dollars sums them, _book is a balance held. get_coverage lists each with the scopes it has.","schema":{"type":"string","enum":["multifamily_dollars","multifamily_loans_made","investor_1to4_dollars","investor_1to4_loans_made","sba_7a_dollars","sba_7a_loans_made","sba_504_first_lien_dollars","sba_504_projects","credit_union_real_estate_originations_dollars","multifamily_book","construction_book","owner_occupied_cre_book","investor_cre_book","farmland_book","business_book","commercial_book"]}},{"name":"scope","in":"query","required":false,"description":"national (default), or a two-letter state. Some metrics are national only; the error lists the scopes a metric has.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows to return, 1 to 10. Default 6 for find_loan_comps and 10 elsewhere. The result says when fewer were allowed.","schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging.","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rank_lenders_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/compare":{"get":{"operationId":"compare_lenders","summary":"Compare lenders side by side","description":"Returns two to four lenders side by side as a table of comparable measures (assets, books by category, loans made, offices, capacity measures with their captions) and, if a deal is given, each lender's evidence on it. Accepts names or identifiers. Use it to weigh named lenders against each other; to find lenders first use find_loan_comps or search_lenders.","tags":["Lenders"],"parameters":[{"name":"ids","in":"query","required":true,"description":"Two to four lenders: names, slugs or identifiers such as fdic:6653. A comma-separated string also works.","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"lane","in":"query","required":false,"description":"Optional deal lane","schema":{"type":"string","enum":["multifamily","investor_1to4","cre_investor","cre_owner","construction","residential_development","farmland","business","sba_7a","sba_504"]}},{"name":"state","in":"query","required":false,"description":"Optional deal state","schema":{"type":"string"}},{"name":"amount","in":"query","required":false,"description":"Optional deal amount in dollars","schema":{"type":"number"}},{"name":"purpose","in":"query","required":false,"description":"Optional deal purpose","schema":{"type":"string","enum":["purchase","refinance","cash_out","improvement","construction","working_capital","equipment","bridge"]}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/compare_lenders_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"More than one lender or place fits. The body lists the candidates. Repeat the call with one of them.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/changes":{"get":{"operationId":"get_changes","summary":"Get what changed and when it was published","description":"Returns data releases and the changes they carried, newest first: what each release took from the latest filings, the date this site published it and the filing period it covers. Filter by since (publish date) or period_since (filing period), and by kind. Use it for \"what is new\" or to keep a copy current. It also says whether the next quarter's call reports are yet published.","tags":["Lenders"],"parameters":[{"name":"since","in":"query","required":false,"description":"YYYY-MM-DD: only releases published after this date","schema":{"type":"string"}},{"name":"period_since","in":"query","required":false,"description":"YYYY-MM-DD: only changes whose filing period ends after this date","schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"description":"Kind of change","schema":{"type":"string","enum":["release","market","balance_change","new_category","filer_appeared","filer_disappeared","status_change","hmda_change","sba_change"]}},{"name":"limit","in":"query","required":false,"description":"Rows to return, 1 to 10. Default 6 for find_loan_comps and 10 elsewhere. The result says when fewer were allowed.","schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging.","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_changes_result"}}}},"400":{"description":"The call was not accepted: a value, a field or a sensitive field. The body names the field, the accepted values and the closest accepted value.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/releases":{"get":{"operationId":"list_releases","summary":"Every data release, newest first","description":"A release is one build of the data. Its id is the data_version on every answer.","tags":["Service"],"parameters":[],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"type":"object","required":["data_version","license","latest","releases","cite"],"properties":{"data_version":{"type":"string"},"license":{"type":"string","format":"uri"},"latest":{"type":"string"},"releases":{"type":"array","items":{"$ref":"#/components/schemas/Release"}},"next_expected":{},"cite":{"$ref":"#/components/schemas/Cite"}}}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/releases/{release_id}":{"get":{"operationId":"get_release","summary":"One data release","tags":["Service"],"parameters":[{"name":"release_id","in":"path","required":true,"description":"A release id, for example 2026-11-08.1. /releases lists them.","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Release"},{"type":"object","properties":{"data_version":{"type":"string"},"license":{"type":"string","format":"uri"},"latest":{"type":"boolean"},"cite":{"$ref":"#/components/schemas/Cite"}}}]}}}},"401":{"description":"The key sent is not valid. A call with no key at all is answered within the no-key limits.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at that address or with that identifier. The body lists the closest names where there are any.","headers":{},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"The daily allowance or the fair-use rate is used. Retry-After and the body say when to come back.","headers":{"Retry-After":{"description":"Seconds until the call will be accepted","schema":{"type":"integer"}},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"X-LR-Rows-Remaining":{"$ref":"#/components/headers/X-LR-Rows-Remaining"},"X-LR-Data-Version":{"$ref":"#/components/headers/X-LR-Data-Version"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"The data store is not answering. Retry after the time in Retry-After.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/health":{"get":{"operationId":"get_health","summary":"Is the API up, and how old is the data","description":"Never metered. 200 when the data store answers, 503 when it does not.","tags":["Service"],"security":[{}],"parameters":[],"responses":{"200":{"description":"Up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}},"503":{"description":"The data store is not answering","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}}}}},"components":{"securitySchemes":{"key":{"type":"http","scheme":"bearer","description":"An account key. Optional: a call with no key is answered within the no-key limits."}},"headers":{"RateLimit":{"description":"What is left of the daily allowance and the seconds until it resets, in the IETF RateLimit header fields draft form, for example \"calls\";r=42;t=3600. The draft is not final, so read it leniently.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"The allowance itself, for example \"calls\";q=50;w=86400.","schema":{"type":"string"}},"X-LR-Rows-Remaining":{"description":"Rows left today for this caller","schema":{"type":"integer"}},"X-LR-Data-Version":{"description":"The data release the answer was computed from","schema":{"type":"string"}}},"schemas":{"Prov":{"type":"object","properties":{"source":{"type":"string"},"as_of":{"type":"string"},"cite_as":{"type":"string"},"license":{"type":"string","format":"uri"},"is_paid":{"type":"boolean"},"label":{"type":"string"},"listing_state":{"type":"string","enum":["unverified","claimed","verified"],"description":"Who reviewed the page. Never changes order."}},"required":["source","as_of","cite_as","license","is_paid","label"],"additionalProperties":true},"Ids":{"type":"object","properties":{"fdic":{"type":["string","null"]},"rssd":{"type":["string","null"]},"ncua":{"type":["string","null"]},"lei":{"type":["string","null"]}},"required":[],"additionalProperties":true},"Cite":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["text","url"],"additionalProperties":true},"Pair":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"],"additionalProperties":true},"LenderRef":{"type":"object","allOf":[{"$ref":"#/components/schemas/Prov"}],"properties":{"lr_id":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"type":{"type":"string","enum":["bank","savings","credit_union","nonbank","depository_inactive"]},"type_label":{"type":"string"},"hq":{"type":"object","properties":{"city":{"type":["string","null"]},"state":{"type":["string","null"]}},"required":[],"additionalProperties":true},"ids":{"$ref":"#/components/schemas/Ids"}},"required":["lr_id","slug","url","name","type","ids"],"additionalProperties":true},"LenderListRow":{"type":"object","allOf":[{"$ref":"#/components/schemas/Prov"}],"properties":{"lr_id":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"type":{"type":"string","enum":["bank","savings","credit_union","nonbank","depository_inactive"]},"status":{"type":"string","enum":["operating","merged","closed","converted","unclear","not_in_coverage"]},"hq":{"type":"object","properties":{"city":{"type":["string","null"]},"state":{"type":["string","null"]}},"required":[],"additionalProperties":true},"ids":{"$ref":"#/components/schemas/Ids"},"assets":{"type":["integer","null"]},"commercial_book":{"type":["integer","null"]},"flags":{"type":"array","items":{"type":"string"}},"loans_made":{"type":"object","properties":{},"required":[],"additionalProperties":true},"participations":{"type":"object","properties":{"bought_h1_2026":{"type":["integer","null"]},"held":{"type":["integer","null"]}},"required":[],"additionalProperties":true}},"required":["lr_id","slug","url","name","type","status","ids"],"additionalProperties":true},"CompRow":{"type":"object","allOf":[{"$ref":"#/components/schemas/Prov"}],"properties":{"lr_id":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"ids":{"$ref":"#/components/schemas/Ids"},"group":{"type":"string","enum":["local","out_of_state","nonbank"]},"level":{"type":"string","enum":["done_this","done_similar","holds_book","elsewhere"]},"level_label":{"type":"string"},"loans_like_this":{"type":"integer"},"loans_in_state":{"type":["integer","null"]},"loans_like_this_in_place":{"type":["integer","null"]},"place_scope":{"type":"object","properties":{"level":{"type":"string","enum":["state","metro","county"]},"name":{"type":"string"}},"required":["level","name"],"additionalProperties":true},"matched_on":{"type":"array","items":{"type":"string"}},"sentence":{"type":"string"},"receipts_total":{"type":["integer","null"]},"receipts":{"type":"object","properties":{"mode":{"type":"string","enum":["rows","cells"]},"total":{"type":["integer","null"]},"rows":{"type":"array","items":{"type":"object","properties":{},"required":[],"additionalProperties":true}}},"required":[],"additionalProperties":true}},"required":["lr_id","slug","url","name","ids","group","level","level_label","loans_like_this","sentence"],"additionalProperties":true},"Release":{"type":"object","properties":{"release_id":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$"},"built_at":{"type":"string","format":"date-time"},"published_at":{"type":"string","format":"date"},"summary":{"type":"string"},"periods":{"type":"object","properties":{"call_report":{"type":"string"},"hmda":{"type":"string"},"sba_through":{"type":"string"}},"required":[],"additionalProperties":true},"counts":{"type":"object","properties":{},"required":[],"additionalProperties":true},"url":{"type":"string","format":"uri"},"previous_release_id":{"type":["string","null"]}},"required":["release_id","built_at","published_at","summary","url"],"additionalProperties":true},"find_loan_comps_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"deal":{"type":"object","properties":{"lane":{"type":"string"},"state":{"type":["string","null"]},"metro":{"type":["string","null"]},"county":{"type":["string","null"]},"amount":{"type":["number","null"]},"purpose":{"type":["string","null"]},"band":{"type":["object","null"]}},"required":["lane"],"additionalProperties":true},"summary":{"type":"string","description":"The headline. States the place level it counts at; a metro or county count comes first when one was asked for."},"answered_at":{"type":"object","properties":{"requested":{"type":"string","enum":["state","metro","county"]},"answered":{"type":"string","enum":["state","metro","county"]},"place":{"type":"string"},"in_place":{"type":"object","properties":{"lenders_with_loans_like_this":{"type":"integer"},"loans_like_this":{"type":"integer"},"period":{"type":"string"}},"required":[],"additionalProperties":true}},"required":["requested","answered","place"],"additionalProperties":true},"assumptions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"assumed":{"type":"string"},"alternatives":{"type":"array","items":{"$ref":"#/components/schemas/Pair"}}},"required":["key","assumed"],"additionalProperties":true},"description":"Choices made for the caller, for example which Columbus. Say them to the user."},"clarifying_questions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"ask":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/Pair"}}},"required":["key","ask"],"additionalProperties":true}},"matched_on":{"type":"array","items":{"type":"string"},"description":"Inputs that narrowed the loans counted: lane, state, metro or county, size, purpose, units, industry"},"not_matched_on":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"reason":{"type":"string"}},"required":["key","reason"],"additionalProperties":true},"description":"Inputs given but not checkable in this lane, with why"},"answerable":{"type":"object","properties":{"size":{"type":"boolean"},"purpose":{"type":"boolean"},"recent":{"type":"boolean"},"property_type":{"type":"boolean"}},"required":["size","purpose","recent","property_type"],"additionalProperties":true},"what_we_dont_know":{"type":"array","items":{"type":"string"},"description":"Repeat these to the user"},"do_not_claim":{"type":"array","items":{"type":"string"},"description":"Statements this answer does not support"},"method":{"type":"string"},"totals":{"type":"object","properties":{"lenders_with_loans_like_this":{"type":"integer"},"loans_like_this":{"type":"integer"}},"required":["lenders_with_loans_like_this","loans_like_this"],"additionalProperties":true},"groups":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["local","out_of_state","nonbank"]},"label":{"type":"string"},"total":{"type":"integer"},"with_loans_like_this":{"type":"integer"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/CompRow"}}},"required":["key","label","total","rows"],"additionalProperties":true}},"ruled_out":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"reason":{"type":"string","enum":["merged","closed","unclear"]},"sentence":{"type":"string"}},"required":["slug","name","reason","sentence"],"additionalProperties":true}},"paging":{"type":"object","properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"returned":{"type":"integer"},"total":{"type":"integer"},"next":{"type":["integer","null"]}},"required":["limit","offset","returned","total"],"additionalProperties":true},"sources":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"},"as_of":{"type":"string"}},"required":["name","url","as_of"],"additionalProperties":true}},"as_of":{"type":"object","properties":{"call_report":{"type":"string"},"hmda":{"type":"string"},"sba_through":{"type":"string"}},"required":[],"additionalProperties":true}},"required":["data_version","cite","license","limits","deal","summary","answered_at","matched_on","answerable","what_we_dont_know","do_not_claim","groups","paging","sources","as_of"],"additionalProperties":true},"search_lenders_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"total":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"next":{"type":["integer","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/LenderListRow"}},"as_of":{"type":["string","null"]},"note":{"type":"string"}},"required":["data_version","cite","license","limits","total","offset","limit","results"],"additionalProperties":true},"get_lender_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"view":{"type":"string","enum":["summary","book","activity","capacity","signals","peers","facts","history","full","as_of"]},"lender":{"type":"object","allOf":[{"$ref":"#/components/schemas/Prov"}],"properties":{"lr_id":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"type":{"type":"string","enum":["bank","savings","credit_union","nonbank","depository_inactive"]},"status":{"type":"string","enum":["operating","merged","closed","converted","unclear","not_in_coverage"]},"status_code":{"type":"string"},"status_detail":{"anyOf":[{"type":"object","properties":{"resolution":{"type":["string","null"]},"statement":{"type":["string","null"]},"successor_name":{"type":["string","null"]},"end_date":{"type":["string","null"]}},"required":[],"additionalProperties":true},{"type":"null"}]},"successor":{"anyOf":[{"type":"object","properties":{"lr_id":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"ids":{"$ref":"#/components/schemas/Ids"}},"required":["slug","url","name"],"additionalProperties":true},{"type":"null"}]},"ids":{"$ref":"#/components/schemas/Ids"},"hq":{"type":"object","properties":{"city":{"type":["string","null"]},"state":{"type":["string","null"]}},"required":[],"additionalProperties":true},"totals":{"type":"object","properties":{"assets":{"type":["integer","null"]},"loans":{"type":["integer","null"]},"commercial_book":{"type":["integer","null"]},"as_of":{"type":["string","null"]}},"required":[],"additionalProperties":true},"facts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"source":{"type":"string"},"as_of":{"type":"string"}},"required":["text","source","as_of"],"additionalProperties":true}},"flags":{"type":"array","items":{"type":"string"}}},"required":["lr_id","slug","url","name","type","status","ids"],"additionalProperties":true},"what_we_dont_know":{"type":"array","items":{"type":"string"},"description":"Repeat these to the user"},"do_not_claim":{"type":"array","items":{"type":"string"},"description":"Statements this answer does not support"}},"required":["data_version","cite","license","limits","view","lender","what_we_dont_know","do_not_claim"],"additionalProperties":true},"check_lender_status_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"result":{"type":"string","enum":["found","ambiguous","not_in_coverage"]},"lender":{"anyOf":[{"$ref":"#/components/schemas/LenderRef"},{"type":"null"}]},"status":{"type":"string","enum":["operating","merged","closed","converted","unclear","not_in_coverage"]},"is_operating":{"type":["boolean","null"],"description":"true for an active filer, false for a recorded merger or closure, null when the record does not say or the lender is not in coverage"},"statement":{"type":"string","description":"One sentence, as the record states it"},"effective_date":{"type":["string","null"]},"successor":{"anyOf":[{"type":"object","properties":{"lr_id":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"ids":{"$ref":"#/components/schemas/Ids"}},"required":["slug","url","name"],"additionalProperties":true},{"type":"null"}]},"last_filing":{"anyOf":[{"type":"object","properties":{"source":{"type":"string"},"period":{"type":"string"}},"required":["source","period"],"additionalProperties":true},{"type":"null"}]},"regulator_record":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["name","url"],"additionalProperties":true}},"candidates":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"state":{"type":["string","null"]},"url":{"type":"string","format":"uri"}},"required":[],"additionalProperties":true}},"coverage":{"type":"string","description":"What this record includes, so absence is read correctly"},"what_we_dont_know":{"type":"array","items":{"type":"string"},"description":"Repeat these to the user"},"do_not_claim":{"type":"array","items":{"type":"string"},"description":"Statements this answer does not support"}},"required":["data_version","cite","license","limits","result","status","is_operating","statement","regulator_record","coverage","what_we_dont_know","do_not_claim"],"additionalProperties":true},"get_lender_activity_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"lender":{"$ref":"#/components/schemas/LenderRef"},"scope":{"type":"object","properties":{"state":{"type":["string","null"]},"metro":{"type":["string","null"]},"program":{"type":["string","null"]},"period":{"type":"string"}},"required":[],"additionalProperties":true},"figures":{"type":"object","properties":{},"required":[],"additionalProperties":true},"receipts":{"type":"array","items":{"type":"object","properties":{},"required":[],"additionalProperties":true}},"receipts_mode":{"type":"string","enum":["rows","cells"]},"what_we_dont_know":{"type":"array","items":{"type":"string"},"description":"Repeat these to the user"},"do_not_claim":{"type":"array","items":{"type":"string"},"description":"Statements this answer does not support"}},"required":["data_version","cite","license","limits","lender","scope","figures","receipts_mode","what_we_dont_know","do_not_claim"],"additionalProperties":true},"list_market_lenders_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"place":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string","enum":["state","metro"]},"code":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"required":["name","kind","code"],"additionalProperties":true},"lane":{"type":"string"},"period":{"type":"string"},"as_of":{"type":"string"},"total":{"type":"integer"},"total_loans":{"type":["integer","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/LenderListRow"}},"offset":{"type":"integer"},"limit":{"type":"integer"},"next":{"type":["integer","null"]},"note":{"type":"string"}},"required":["data_version","cite","license","limits","place","total","results","offset","limit"],"additionalProperties":true},"rank_lenders_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"metric":{"type":"string"},"metric_alias_of":{"type":["string","null"]},"label":{"type":"string"},"unit":{"type":"string","enum":["dollars","loans","projects"]},"basis":{"type":["string","null"]},"scope":{"type":"string"},"scopes_available":{"type":"array","items":{"type":"string"}},"period":{"type":"string"},"as_of":{"type":"string"},"list_size":{"type":"integer","description":"Rows in this ranking as published (a state list may hold only the first 15 or 50)"},"universe_size":{"type":["integer","null"],"description":"Lenders with any value on this measure in this scope, if known"},"truncated":{"type":"boolean","description":"true when the published list is shorter than the universe"},"url":{"type":"string","format":"uri","description":"The ranking page for this metric and scope; cite it"},"results":{"type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/Prov"}],"properties":{"position":{"type":"integer"},"lr_id":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string","format":"uri"},"name":{"type":"string"},"type":{"type":"string","enum":["bank","savings","credit_union","nonbank","depository_inactive"]},"hq_state":{"type":["string","null"]},"value":{"type":["number","null"]},"loans":{"type":["integer","null"]},"prior":{"type":["number","null"]},"yoy_pct":{"type":["number","null"]}},"required":["position","slug","url","name","value"],"additionalProperties":true}},"offset":{"type":"integer"},"limit":{"type":"integer"},"next":{"type":["integer","null"]},"note":{"type":"string"}},"required":["data_version","cite","license","limits","metric","label","unit","scope","scopes_available","period","as_of","list_size","truncated","url","results"],"additionalProperties":true},"compare_lenders_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"lenders":{"type":"array","items":{"$ref":"#/components/schemas/LenderRef"},"minItems":2,"maxItems":4},"matrix":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"unit":{"type":"string"},"as_of":{"type":["string","null"]},"source":{"type":"string"},"values":{"type":"object","properties":{},"required":[],"additionalProperties":true}},"required":["key","label","unit","values"],"additionalProperties":true}},"captions":{"type":"array","items":{"type":"string"},"description":"Captions that must stay with the figures they explain, for example Not a rating"},"deal":{"anyOf":[{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{},"required":[],"additionalProperties":true}},"matched_on":{"type":"array","items":{"type":"string"}},"answerable":{"type":"object","properties":{},"required":[],"additionalProperties":true}},"required":[],"additionalProperties":true},{"type":"null"}]},"what_we_dont_know":{"type":"array","items":{"type":"string"},"description":"Repeat these to the user"},"do_not_claim":{"type":"array","items":{"type":"string"},"description":"Statements this answer does not support"}},"required":["data_version","cite","license","limits","lenders","matrix","captions","what_we_dont_know","do_not_claim"],"additionalProperties":true},"get_changes_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"latest_release":{"$ref":"#/components/schemas/Release"},"next_expected":{"type":"object","properties":{"event":{"type":"string"},"status":{"type":"string","enum":["not_published","published","unknown"]},"checked_at":{"type":["string","null"]}},"required":["event","status"],"additionalProperties":true},"releases":{"type":"array","items":{"$ref":"#/components/schemas/Release"}},"items":{"type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/Prov"}],"properties":{"scope":{"type":"string","enum":["market","lender"]},"kind":{"type":"string"},"metric":{"type":["string","null"]},"text":{"type":"string"},"prev":{"type":["number","null"]},"curr":{"type":["number","null"]},"delta":{"type":["number","null"]},"delta_pct":{"type":["number","null"]},"period_prev":{"type":["string","null"]},"period_curr":{"type":["string","null"]},"release_id":{"type":"string"},"published_at":{"type":"string","format":"date"},"url":{"type":"string","format":"uri"},"lr_id":{"type":["string","null"]},"slug":{"type":["string","null"]},"name":{"type":["string","null"]}},"required":["scope","kind","text","release_id","published_at","url"],"additionalProperties":true}},"total":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"next":{"type":["integer","null"]},"note":{"type":"string"}},"required":["data_version","cite","license","limits","latest_release","next_expected","releases","items","total","offset","limit"],"additionalProperties":true},"resolve_place_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"query":{"type":"string"},"ambiguous":{"type":"boolean"},"assumption":{"type":["string","null"],"description":"The candidate to use if the user does not say, in one sentence"},"candidates":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["metro","county","state"]},"name":{"type":"string"},"state":{"type":"string"},"cbsa":{"type":["string","null"]},"county_fips":{"type":["string","null"]},"population_rank":{"type":["integer","null"]},"in_coverage":{"type":"boolean"},"loans_in_place":{"type":["integer","null"],"description":"Recorded multifamily loans in the latest HMDA year; shown only when the place has 5 or more"},"page_url":{"type":["string","null"],"format":"uri"},"use":{"type":"object","properties":{"metro":{"type":"string"},"county":{"type":"string"},"state":{"type":"string"}},"required":[],"additionalProperties":true,"description":"Pass these arguments to find_loan_comps or list_market_lenders"}},"required":["kind","name","state","in_coverage","use"],"additionalProperties":true}},"note":{"type":"string"}},"required":["data_version","cite","license","limits","query","ambiguous","candidates"],"additionalProperties":true},"get_coverage_result":{"type":"object","properties":{"data_version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}\\.\\d+$","description":"The data release this answer was computed from"},"cite":{"$ref":"#/components/schemas/Cite"},"license":{"type":"string","format":"uri"},"limits":{"type":"object","properties":{"rows_per_call":{"type":"integer"},"capped":{"type":"boolean"}},"required":["rows_per_call","capped"],"additionalProperties":true},"name":{"type":"string"},"description":{"type":"string"},"operator":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"contact":{"type":"string"}},"required":["name"],"additionalProperties":true},"release":{"$ref":"#/components/schemas/Release"},"as_of":{"type":"object","properties":{"call_report":{"type":"string"},"prior_call_report":{"type":["string","null"]},"hmda_latest":{"type":"string"},"sba_through":{"type":"string"}},"required":[],"additionalProperties":true},"counts":{"type":"object","properties":{"lenders":{"type":"integer"},"deals":{"type":"integer"}},"required":[],"additionalProperties":true},"coverage":{"type":"object","properties":{"not_covered":{"type":"string"}},"required":[],"additionalProperties":true},"sources":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"url":{"type":["string","null"]},"as_of":{"type":["string","null"]}},"required":["code","label"],"additionalProperties":true}},"known_limits":{"type":"array","items":{"type":"string"}},"rankings":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string"},"label":{"type":"string"},"unit":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"period":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["metric","label","unit","scopes","url"],"additionalProperties":true}},"how_the_order_works":{"type":"string"},"listing_states":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","enum":["unverified","claimed","verified"]},"label":{"type":"string"},"definition":{"type":"string"}},"required":["state","label","definition"],"additionalProperties":true}},"request_financing_url":{"type":"string","format":"uri"},"license_text":{"type":"string"},"citation_format":{"type":"string"},"links":{"type":"object","properties":{},"required":[],"additionalProperties":true},"next_quarter":{"type":"object","properties":{"call_reports_published":{"type":"boolean"},"checked_at":{"type":["string","null"]}},"required":[],"additionalProperties":true}},"required":["data_version","cite","license","limits","name","description","operator","release","as_of","counts","coverage","sources","known_limits","rankings","license_text","citation_format","links"],"additionalProperties":true},"ListingState":{"type":"string","enum":["unverified","claimed","verified"],"description":"listing_state is one of unverified, claimed or verified. It describes the listing, never the lender. Verified is a paid listing. Order is not affected by payment. It is read after the order of a result is final.","x-enum-descriptions":{"unverified":"Unverified listing. Built from public records. The lender has not reviewed the page. Every lender starts this way, and it says nothing about the lender itself. Claiming is free.","claimed":"Claimed. A representative of the lender proved they act for it, with a work email address at the lender's own domain or another accepted proof (a DNS record on that domain, a call to the main number, a signed letter from an officer, or a review of a non-bank's records). They can correct facts. Claiming is free. The lending details have not been confirmed.","verified":"Verified (paid). The lender pays a flat monthly fee for the listing and confirmed its lending details on a stated date. It is not a rating or an opinion of the lender. Paying never changes where a lender appears in search, lists or rankings."}},"Problem":{"type":"object","description":"A problem document (RFC 9457). type is an address that explains the error. The other members say how to fix the call.","required":["type","title","status","detail"],"properties":{"type":{"type":"string","format":"uri","enum":["https://lender.report/errors/invalid-parameter/","https://lender.report/errors/unknown-field/","https://lender.report/errors/sensitive-field/","https://lender.report/errors/not-found/","https://lender.report/errors/not-in-coverage/","https://lender.report/errors/ambiguous/","https://lender.report/errors/daily-limit/","https://lender.report/errors/rate-limited/","https://lender.report/errors/key-not-recognized/","https://lender.report/errors/needs-account/","https://lender.report/errors/unavailable/"]},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"code":{"type":"string"},"instance":{"type":"string"},"field":{"type":"string","description":"The field the problem is about"},"did_you_mean":{"type":"string","description":"The nearest accepted value"},"accepted":{"type":"array","items":{},"description":"The values or fields the call does take"},"rejected":{"type":"array","items":{"type":"string"},"description":"The fields refused. A refused value is never repeated."},"candidates":{"type":"array","items":{"type":"object"},"description":"The lenders or places that fit, when more than one does"},"retry_after_seconds":{"type":"integer"},"resets_at":{"type":"string","format":"date-time"},"limit":{"type":"object"},"limits":{"type":"string","format":"uri"},"signin":{"type":"string","format":"uri"},"needs":{"type":"string"},"details":{"type":"string"},"ask":{"type":"string","description":"A question to put to the user before calling again"},"error":{"type":"string","description":"The same message as detail, for older clients"}}},"Health":{"type":"object","required":["status","checks"],"properties":{"status":{"type":"string","enum":["ok","unavailable"]},"service":{"type":"string"},"version":{"type":"string"},"preview":{"type":"boolean"},"data_version":{"type":["string","null"]},"built_at":{"type":["string","null"]},"data_age_days":{"type":["integer","null"]},"as_of":{"type":["object","null"]},"next_expected":{},"checks":{"type":"object"},"links":{"type":"object"}}}}},"x-error-types":{"invalid-parameter":{"status":400,"title":"A value was not accepted","url":"https://lender.report/errors/invalid-parameter/"},"unknown-field":{"status":400,"title":"A field is not accepted","url":"https://lender.report/errors/unknown-field/"},"sensitive-field":{"status":400,"title":"A sensitive field was refused","url":"https://lender.report/errors/sensitive-field/"},"not-found":{"status":404,"title":"Not found","url":"https://lender.report/errors/not-found/"},"not-in-coverage":{"status":404,"title":"Not in this record","url":"https://lender.report/errors/not-in-coverage/"},"ambiguous":{"status":409,"title":"More than one fits","url":"https://lender.report/errors/ambiguous/"},"daily-limit":{"status":429,"title":"The daily allowance is used","url":"https://lender.report/errors/daily-limit/"},"rate-limited":{"status":429,"title":"Too many requests in a few seconds","url":"https://lender.report/errors/rate-limited/"},"key-not-recognized":{"status":401,"title":"That key was not recognised","url":"https://lender.report/errors/key-not-recognized/"},"needs-account":{"status":403,"title":"This needs a free account","url":"https://lender.report/errors/needs-account/"},"unavailable":{"status":503,"title":"Temporarily unavailable","url":"https://lender.report/errors/unavailable/"}},"x-listing-states":[{"state":"unverified","label":"Unverified listing","definition":"Built from public records. The lender has not reviewed the page. Every lender starts this way, and it says nothing about the lender itself. Claiming is free."},{"state":"claimed","label":"Claimed","definition":"A representative of the lender proved they act for it, with a work email address at the lender's own domain or another accepted proof (a DNS record on that domain, a call to the main number, a signed letter from an officer, or a review of a non-bank's records). They can correct facts. Claiming is free. The lending details have not been confirmed."},{"state":"verified","label":"Verified (paid)","definition":"The lender pays a flat monthly fee for the listing and confirmed its lending details on a stated date. It is not a rating or an opinion of the lender. Paying never changes where a lender appears in search, lists or rankings."}]}