{"id":23802903,"url":"https://github.com/kskarthik/indian-fincodes-api","last_synced_at":"2025-07-25T04:38:26.585Z","repository":{"id":229212614,"uuid":"776118237","full_name":"kskarthik/indian-fincodes-api","owner":"kskarthik","description":"A REST API server for searching Indian banks, pincodes, HSN/SAC codes. Created using docker \u0026 meilisearch","archived":false,"fork":false,"pushed_at":"2025-03-27T11:52:14.000Z","size":4032,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T05:52:11.471Z","etag":null,"topics":["bank","docker","hsn-code","ifsc","india","meilisearch","pincode-finder","rest-api"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/kskarthik/indian-fincodes-api","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kskarthik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-22T18:05:58.000Z","updated_at":"2025-03-19T00:56:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"2af74c49-2a5e-4655-aadd-3b6b197c1162","html_url":"https://github.com/kskarthik/indian-fincodes-api","commit_stats":null,"previous_names":["kskarthik/indian-fincodes-api"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/kskarthik/indian-fincodes-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kskarthik%2Findian-fincodes-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kskarthik%2Findian-fincodes-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kskarthik%2Findian-fincodes-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kskarthik%2Findian-fincodes-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kskarthik","download_url":"https://codeload.github.com/kskarthik/indian-fincodes-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kskarthik%2Findian-fincodes-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266955763,"owners_count":24012062,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bank","docker","hsn-code","ifsc","india","meilisearch","pincode-finder","rest-api"],"created_at":"2025-01-01T22:28:24.796Z","updated_at":"2025-07-25T04:38:26.576Z","avatar_url":"https://github.com/kskarthik.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Indian Financial codes API ![docker ci badge](https://github.com/movim/movim/actions/workflows/docker.yml/badge.svg?event=push)\n\n![image](https://github.com/kskarthik/indian-fincodes-api/assets/11899221/6f556c36-ec96-42fd-a016-20f3664b4c77)\n\nThis repository contains scripts which builds a REST API service in a docker image\n\nThe following data is provided:\n\n- Pincodes [source](https://data.gov.in/catalog/all-india-pincode-directory)\n- Banks [source](https://github.com/razorpay/ifsc/)\n- HSN \u0026 SAC [source](https://services.gst.gov.in/services/searchhsnsac)\n\n# How it's done\nThe data is fetched from various sources, processed and indexed to the [meilisearch](https://www.meilisearch.com) docker image \u0026 a new image is created from it \u0026 pushed to docker hub. All this process is automated using github actions.\n\n# Links\n\n- [Docker repo](https://hub.docker.com/r/kskarthik/indian-fincodes-api)\n- [Meilisearch API Reference](https://www.meilisearch.com/docs/reference/api/overview)\n\n# Usage\n\n```sh\ndocker pull kskarthik/indian-fincodes-api:latest\n\n# set MEILI_MASTER_KEY to your preferred value\ndocker run --rm -d \\\n  -p 7700:7700 \\\n  -e MEILI_MASTER_KEY='MASTER_KEY'\\\n  kskarthik/indian-fincodes-api:latest\n```\n\nTo access the server, Visit `http://localhost:7700` in the browser\n\n# Examples\n\nGet the list of indexes:\n\n```sh\ncurl http://localhost:7700/indexes \n{\n  \"results\": [\n    {\n      \"uid\": \"banks\",\n      \"createdAt\": \"2024-03-27T10:57:53.787331548Z\",\n      \"updatedAt\": \"2024-03-27T10:58:11.549315386Z\",\n      \"primaryKey\": \"IFSC\"\n    },\n    {\n      \"uid\": \"hsn_sac_codes\",\n      \"createdAt\": \"2024-03-27T11:03:32.334812729Z\",\n      \"updatedAt\": \"2024-03-27T11:03:34.449263657Z\",\n      \"primaryKey\": \"id\"\n    },\n    {\n      \"uid\": \"pincodes\",\n      \"createdAt\": \"2024-03-27T11:03:16.545030985Z\",\n      \"updatedAt\": \"2024-03-27T11:03:24.393231938Z\",\n      \"primaryKey\": \"id\"\n    }\n  ],\n  \"offset\": 0,\n  \"limit\": 20,\n  \"total\": 3\n}\n```\n\nPerform search on an index:\n\n```sh\n curl -s -X POST 'http://localhost:7700/indexes/pincodes/search' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n    \"q\": \"500001\",\n    \"limit\": 2\n  }'\n\n{\n  \"hits\": [\n    {\n      \"id\": 4678,\n      \"officename\": \"Moazzampura S.O\",\n      \"pincode\": \"500001\",\n      \"officeType\": \"S.O\",\n      \"Deliverystatus\": \"Non-Delivery\",\n      \"divisionname\": \"Hyderabad City\",\n      \"regionname\": \"Hyderabad City\",\n      \"circlename\": \"Andhra Pradesh\",\n      \"Taluk\": \"Nampally\",\n      \"Districtname\": \"Hyderabad\",\n      \"statename\": \"ANDHRA PRADESH\"\n    },\n    {\n      \"id\": 4704,\n      \"officename\": \"Seetharampet S.O\",\n      \"pincode\": \"500001\",\n      \"officeType\": \"S.O\",\n      \"Deliverystatus\": \"Non-Delivery\",\n      \"divisionname\": \"Hyderabad City\",\n      \"regionname\": \"Hyderabad City\",\n      \"circlename\": \"Andhra Pradesh\",\n      \"Taluk\": \"Nampally\",\n      \"Districtname\": \"Hyderabad\",\n      \"statename\": \"ANDHRA PRADESH\"\n    }\n  ],\n  \"query\": \"500001\",\n  \"processingTimeMs\": 0,\n  \"limit\": 2,\n  \"offset\": 0,\n  \"estimatedTotalHits\": 213\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkskarthik%2Findian-fincodes-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkskarthik%2Findian-fincodes-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkskarthik%2Findian-fincodes-api/lists"}