Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kskarthik/indian-fincodes-api
A REST API server for searching Indian banks, pincodes, HSN/SAC codes. Created using docker & meilisearch
https://github.com/kskarthik/indian-fincodes-api
bank docker hsn-code ifsc india meilisearch pincode-finder rest-api
Last synced: 5 days ago
JSON representation
A REST API server for searching Indian banks, pincodes, HSN/SAC codes. Created using docker & meilisearch
- Host: GitHub
- URL: https://github.com/kskarthik/indian-fincodes-api
- Owner: kskarthik
- Created: 2024-03-22T18:05:58.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-04T13:48:41.000Z (4 months ago)
- Last Synced: 2024-09-05T17:49:13.068Z (4 months ago)
- Topics: bank, docker, hsn-code, ifsc, india, meilisearch, pincode-finder, rest-api
- Language: Python
- Homepage: https://hub.docker.com/r/kskarthik/indian-fincodes-api
- Size: 3.86 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Indian Financial codes API 
This repository contains scripts which builds a REST API service in a docker image
The following data is provided:
- Pincodes [source](https://data.gov.in/catalog/all-india-pincode-directory)
- Banks [source](https://github.com/razorpay/ifsc/)
- HSN & SAC [source](https://services.gst.gov.in/services/searchhsnsac)
# How it's done
0. The data is fetched from various sources
1. Data is processed and indexed to the [meilisearch](https://www.meilisearch.com) docker image
2. Tests are preformed against the docker image to make sure the data is properly indexed
3. A new image is created & tagged
4. Pushed to docker hub
> [!NOTE]
> This process is automated using github actions.
# Links
- [Dockerhub repo](https://hub.docker.com/r/kskarthik/indian-fincodes-api)
- [Meilisearch API Reference](https://www.meilisearch.com/docs/reference/api/overview)
# Usage
```sh
docker pull kskarthik/indian-fincodes-api:latest
# set MEILI_MASTER_KEY to your preferred value
docker run --rm -d \
-p 7700:7700 \
-e MEILI_MASTER_KEY='MASTER_KEY'\
kskarthik/indian-fincodes-api:latest
```
To access the server, Visit `http://localhost:7700` in the browser
# API Examples
> [!NOTE]
> Meilisearch [API Reference](https://www.meilisearch.com/docs/reference/api/overview) has in-depth documentation regarding various search features
Get the list of indexes:
```sh
curl http://localhost:7700/indexes
{
"results": [
{
"uid": "banks",
"createdAt": "2024-03-27T10:57:53.787331548Z",
"updatedAt": "2024-03-27T10:58:11.549315386Z",
"primaryKey": "IFSC"
},
{
"uid": "hsn_sac_codes",
"createdAt": "2024-03-27T11:03:32.334812729Z",
"updatedAt": "2024-03-27T11:03:34.449263657Z",
"primaryKey": "id"
},
{
"uid": "pincodes",
"createdAt": "2024-03-27T11:03:16.545030985Z",
"updatedAt": "2024-03-27T11:03:24.393231938Z",
"primaryKey": "id"
}
],
"offset": 0,
"limit": 20,
"total": 3
}
```
Perform search on an index:
```sh
curl -s -X POST 'http://localhost:7700/indexes/pincodes/search' \
-H 'Content-Type: application/json' \
--data-binary '{
"q": "500001",
"limit": 2
}'
{
"hits": [
{
"id": 4678,
"officename": "Moazzampura S.O",
"pincode": "500001",
"officeType": "S.O",
"Deliverystatus": "Non-Delivery",
"divisionname": "Hyderabad City",
"regionname": "Hyderabad City",
"circlename": "Andhra Pradesh",
"Taluk": "Nampally",
"Districtname": "Hyderabad",
"statename": "ANDHRA PRADESH"
},
{
"id": 4704,
"officename": "Seetharampet S.O",
"pincode": "500001",
"officeType": "S.O",
"Deliverystatus": "Non-Delivery",
"divisionname": "Hyderabad City",
"regionname": "Hyderabad City",
"circlename": "Andhra Pradesh",
"Taluk": "Nampally",
"Districtname": "Hyderabad",
"statename": "ANDHRA PRADESH"
}
],
"query": "500001",
"processingTimeMs": 0,
"limit": 2,
"offset": 0,
"estimatedTotalHits": 213
}
```