List valid states, districts and branch names for a bank
branch_placesFind the exact state, district, and branch spellings accepted by bank branch searches. Use it when a search returns no rows to verify place names before retrying.
Instructions
Discover the exact district and branch-name spellings that search_branches matches on.
The branch search API matches city/district and branch verbatim, so a
near-miss returns zero rows. This tool walks the same hierarchy the API uses,
one level per call, and returns the accepted values at that level:
bank_code alone -> states; add state -> districts; add district ->
branches.
Returns ok: true with level ('states'|'districts'|'branches'), the values
at that level, total found, truncated, and the echoed query.
Call this when a search returned nothing and you need to check spelling - it is cheaper than guessing several more search calls.
Args: bank_code: 4-letter bank code; required. state: ISO 3166-2 code to descend to districts, e.g. "IN-MH". district: District name to descend to branches, e.g. "MUMBAI". limit: Cap on returned values, 1-200 (default 200).
Returns: The place names valid at the requested level, or a structured error payload.
Example: Ask "which states does Kotak serve?" -> call branch_places(bank_code="KKBK").
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Cap on how many values to return, 1-200. Defaults to 200. | |
| state | No | Pass an ISO 3166-2 code ('IN-MH') to move from the states level to the districts level. Omit it to get the list of states. | |
| district | No | Pass a district name from the previous level (e.g. 'MUMBAI') to get the branch names inside it. Requires `state`. | |
| bank_code | Yes | Required 4-letter bank code, e.g. 'HDFC'. The listed values are specific to this bank - a district HDFC operates in may not appear for another bank. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||