{"openapi":"3.1.0","info":{"title":"BSBFinder API","description":"Australian BSB number lookup with change history. Data sourced from official sources.","version":"1.0.0"},"paths":{"/":{"get":{"summary":"Homepage","operationId":"homepage__get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/bsb/{bsb_number}":{"get":{"summary":"Bsb Detail","operationId":"bsb_detail_bsb__bsb_number__get","parameters":[{"name":"bsb_number","in":"path","required":true,"schema":{"type":"string","title":"Bsb Number"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/search":{"get":{"summary":"Search Results","operationId":"search_results_search_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","default":"","title":"Q"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/bank/{slug}":{"get":{"summary":"Bank Detail","operationId":"bank_detail_bank__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/state/{state_code}":{"get":{"summary":"State Detail","operationId":"state_detail_state__state_code__get","parameters":[{"name":"state_code","in":"path","required":true,"schema":{"type":"string","title":"State Code"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/suburb/{state}/{suburb_slug}":{"get":{"summary":"Suburb Detail","operationId":"suburb_detail_suburb__state___suburb_slug__get","parameters":[{"name":"state","in":"path","required":true,"schema":{"type":"string","title":"State"}},{"name":"suburb_slug","in":"path","required":true,"schema":{"type":"string","title":"Suburb Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/postcode/{postcode}":{"get":{"summary":"Postcode Detail","operationId":"postcode_detail_postcode__postcode__get","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string","title":"Postcode"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/discontinued":{"get":{"summary":"Discontinued Index","operationId":"discontinued_index_discontinued_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"bank","in":"query","required":false,"schema":{"type":"string","title":"Bank"}},{"name":"state","in":"query","required":false,"schema":{"type":"string","title":"State"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/changes":{"get":{"summary":"Changes Index","operationId":"changes_index_changes_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/changes/feed.xml":{"get":{"summary":"Changes Feed","operationId":"changes_feed_changes_feed_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/changes/{ym}":{"get":{"summary":"Changes Month","operationId":"changes_month_changes__ym__get","parameters":[{"name":"ym","in":"path","required":true,"schema":{"type":"string","title":"Ym"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/bsb-register-changes":{"get":{"summary":"Bsb Register Changes","operationId":"bsb_register_changes_insights_bsb_register_changes_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/guides":{"get":{"summary":"Guide Index","operationId":"guide_index_guides_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/guide/{slug}":{"get":{"summary":"Guide Detail","operationId":"guide_detail_guide__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tools":{"get":{"summary":"Tools Index","operationId":"tools_index_tools_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/validate":{"get":{"summary":"Validate Page","operationId":"validate_page_validate_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/bulk-lookup":{"get":{"summary":"Bulk Lookup Page","operationId":"bulk_lookup_page_bulk_lookup_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/tools/payid-or-bsb":{"get":{"summary":"Payid Or Bsb Page","operationId":"payid_or_bsb_page_tools_payid_or_bsb_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/decoder":{"get":{"summary":"Decoder Page","operationId":"decoder_page_decoder_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/tools/compare":{"get":{"summary":"Compare Page","operationId":"compare_page_tools_compare_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/tools/branch-finder":{"get":{"summary":"Branch Finder Page","operationId":"branch_finder_page_tools_branch_finder_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/tools/bsb-prefixes":{"get":{"summary":"Bsb Prefixes Page","operationId":"bsb_prefixes_page_tools_bsb_prefixes_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/swift":{"get":{"summary":"Swift Lookup","operationId":"swift_lookup_swift_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/swift/{slug}":{"get":{"summary":"Swift Detail","operationId":"swift_detail_swift__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api":{"get":{"summary":"Api Docs Page","operationId":"api_docs_page_api_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/about":{"get":{"summary":"About","operationId":"about_about_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/contact":{"get":{"summary":"Contact","operationId":"contact_contact_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/privacy":{"get":{"summary":"Privacy","operationId":"privacy_privacy_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/terms":{"get":{"summary":"Terms","operationId":"terms_terms_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/sitemap-index.xml":{"get":{"summary":"Sitemap Index","operationId":"sitemap_index_sitemap_index_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-bsb-{page}.xml":{"get":{"summary":"Sitemap Bsbs","operationId":"sitemap_bsbs_sitemap_bsb__page__xml_get","parameters":[{"name":"page","in":"path","required":true,"schema":{"type":"integer","title":"Page"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sitemap-banks.xml":{"get":{"summary":"Sitemap Banks","operationId":"sitemap_banks_sitemap_banks_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-states.xml":{"get":{"summary":"Sitemap States","operationId":"sitemap_states_sitemap_states_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-suburbs.xml":{"get":{"summary":"Sitemap Suburbs","operationId":"sitemap_suburbs_sitemap_suburbs_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-postcodes.xml":{"get":{"summary":"Sitemap Postcodes","operationId":"sitemap_postcodes_sitemap_postcodes_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-guides.xml":{"get":{"summary":"Sitemap Guides","operationId":"sitemap_guides_sitemap_guides_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-swift.xml":{"get":{"summary":"Sitemap Swift","operationId":"sitemap_swift_sitemap_swift_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-slim.xml":{"get":{"summary":"Sitemap Slim","operationId":"sitemap_slim_sitemap_slim_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sitemap-pages.xml":{"get":{"summary":"Sitemap Pages","operationId":"sitemap_pages_sitemap_pages_xml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/robots.txt":{"get":{"summary":"Robots Txt","operationId":"robots_txt_robots_txt_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/ads.txt":{"get":{"summary":"Ads Txt","operationId":"ads_txt_ads_txt_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1":{"get":{"summary":"Api Root","operationId":"api_root_api_v1_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/bsb/{bsb}":{"get":{"summary":"Lookup Bsb","operationId":"lookup_bsb_api_v1_bsb__bsb__get","parameters":[{"name":"bsb","in":"path","required":true,"schema":{"type":"string","title":"Bsb"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bsb/{bsb}/history":{"get":{"summary":"Bsb History","operationId":"bsb_history_api_v1_bsb__bsb__history_get","parameters":[{"name":"bsb","in":"path","required":true,"schema":{"type":"string","title":"Bsb"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/search":{"get":{"summary":"Search Bsbs","operationId":"search_bsbs_api_v1_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/validate/{bsb}":{"get":{"summary":"Validate Bsb","operationId":"validate_bsb_api_v1_validate__bsb__get","parameters":[{"name":"bsb","in":"path","required":true,"schema":{"type":"string","title":"Bsb"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bulk":{"post":{"summary":"Bulk Lookup","operationId":"bulk_lookup_api_v1_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/institutions":{"get":{"summary":"List Institutions","operationId":"list_institutions_api_v1_institutions_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/stats":{"get":{"summary":"Get Stats","operationId":"get_stats_api_v1_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/report":{"post":{"summary":"Submit Report","operationId":"submit_report_api_v1_report_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BulkRequest":{"properties":{"bsbs":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Bsbs"}},"type":"object","required":["bsbs"],"title":"BulkRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ReportRequest":{"properties":{"bsb":{"type":"string","maxLength":7,"minLength":7,"title":"Bsb"},"message":{"type":"string","maxLength":1000,"title":"Message","default":""}},"type":"object","required":["bsb"],"title":"ReportRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}