Real-Time Co-WIN Vaccine Slot Finder - We Find Your Shot!
Software to fetch the available slots & book the appointment for COVID-19 Vaccination using the APISetu APIs
Download Latest Version of the Software by clicking here & kindly follow the steps mentioned in How To Use
NOTE: Please make sure these changes are done in Config file
appsettings.jsonbefore running the Software
DISCLAIMER
DUE TO LATEST CHANGES IN THE API ACCESS POLICY BY MoHFW, THERE WILL BE NO MORE COMMITS/CONTRIBUTIONS/RELEASES/MAINTENANCE IN THE PROJECT. THE PROJECT HAS BEEN PUT ON INDEFINITE HOLD. GRATEFUL TO EVERY CONTRIBUTORS, SUPPORTERS, USERS THAT WE COULD HELP YOU IN THE CRISIS. EVEN THOUGH YOU MAY STILL USE THE APP, WE ADVISE NOT TO MISUSE IT, OTHERWISE YOU MIGHT FACE LEGAL ISSUES. USE IT AT YOUR OWN RISK
NOTE: Please go through the Disclaimer, End User Lisence Agreement & the Privacy Policy, proceed further only if you accept the Terms and Conditions to use the Application/Software
Important:
- This is a proof of concept project. I do NOT endorse or condone, in any shape or form, automating any monitoring/booking tasks. Developed for Educational Purpose; USE IT AT YOUR OWN RISK. I SHOULD NOT BE DEEMED RESPONSIBLE FOR ANY LEGAL CONCERNS.
- This CANNOT book slots automatically. It doesn't skip any of the steps that a normal user would have to take on the official portal. You will still have to enter the OTP and Captcha. This just helps to do it from Console rather than through Official WebApps/Apps.
- This goes without saying but, once you get your shot, please do help out any underprivileged people around you who may not have a laptop or the know-how. For instance any sort of domestic help, or the staff in your local grocery store, or literally the thousands of people who don't have the knowledge or luxury we do.
- Do NOT use unless all the beneficiaries selected are supposed to get the same vaccine and dose.
- When multiple beneficiaries are added for a single registered mobile number, all beneficiaries will get the Same Dose, Same Vaccine, Same Centre and Same Slot. In case any of this doesn't meet the requirements, booking might not be successful.
- While selecting beneficiaries, make sure that selected beneficiaries are all taking the same dose: either first OR second. Please do no try to club together booking for first dose for one beneficiary and second dose for another beneficiary.
- While selecting beneficiaries, also make sure that beneficiaries selected for second dose are all taking the same vaccine: COVISHIELD OR COVAXIN OR SPUTNIK V. Please do no try to club together booking for beneficiary taking COVISHIELD with beneficiary taking COVAXIN.
- If you're selecting multiple beneficiaries, make sure all are of the same age group (45+ or 18+) as defined by the govt. Please do not try to club together booking for younger and older beneficiaries.
- AUTO BOOKING is ON by default, so it books the slot after you enter a valid captcha (when AutoCaptcha is turned Off) for the Slot which is displayed. So, if you feel you want some particular vaccination centre(s), make sure you are searching by PIN Code for the particular Vaccination Centre(s) or even by the Names of the Vaccination Centres within the PINCode. In case, you don't want to book the slot, you might simply close the Captcha Popup, and the App will try further to book the next available slots in First-Come-First-Serve Basis.
- If you accidentally book a slot, don't worry. You can always login to the Official portal and cancel or re-schedule the booking. There is no option for reschedule or cancel of Booking of Slot available in the Application. There will be an X symbol on the right-top corner for each beneficiary to cancel from CoWIN Portal.
- There is no option to register new mobile or add beneficiaries. This can be used only after beneficiary has been added through the Official WebApp of CoWIN.
Glimpse of the Application:
Application With Bare Miminum Configuration Changes
Application Start - Software Update Notifier
Application Start - Disclaimer, End-User Lisence Agreement, T&C, Privacy Policy Agreement Consent
Application Start - OTP Generation
Application Start - OTP Validated - BearerToken Generation
Application Start - OTP Validated - Invalid BearerToken provided in Config; Regeneration Session by Resending OTP
Application Start - Invaid OTP Entered. Re-Generating new OTP
Application OTP Retrigger In Case OTP is not received within time. Press Enter to Retrigger OTP
Application Slot Booking - Captcha Input
Application Slot Booking - Manual Captcha Input
Application Slot Booking - AI Assisted AutoCaptcha Feature
Application Slot Booking - Using Bearer Token for Session Resuse with Manual Captcha
Successful Booking Scenario - With Manual Captcha
Successful Booking Scenario - With AI-Auto Captcha
Successful Booking Scenario - Showing Support & Sharing Word of Mouth
Unsuccessful Booking - All Slots Full
Unsuccessful Booking - Beneficiary Details Incorrect
Unsuccessful Booking - Server Under Heavy Load
Application Session Regeneration on TimeOut
Application OTP Validity Expired (Expiry Time 3 Minutes from Generation) when user enter the OTP for validation
PRO TIP
When the Captcha pops up in the process of booking, DO NOT use your mouse to click on the Popup, you can start typing it immediately as the app would remain ready to accept your input. Once captcha is entered, then press Enter to submit. This way, it is faster than operating via Mouse, as every second matters! In case, you are unable to get your booking successful in first try, when subsequent captch pops up, you will NOT need to use your mouse and click on Popup, you can right away start typing the 5 captcha characters and press Enter! Boom, it'll work
Enjoy and feel free to Star the Repo, if it could help you in any way! Also, feel free to share screenshot (after hiding personal information) as a New Pull Request in the /data/ folder or a New Issue in case you could successfully book through the App. Also share your feedback through issues or just comment/share/like in the associated LinkedIn Post. That'll be used as References/Testimonials in the Application and will increase the credibility of the App.
Application Features
Following are some of the main features of the App:
- OTP Generation/Validation
- Search by Either PINCode or District or Both PINCode and District with preference to PINCode for better Searching
- Auto Retry To Fetch Slots Every 2 Seconds
- BEEP BEEP User Notifier On Slot Availability To Book the Available Slot
- OTP Notifier for New Session & On Timeout
- Captcha Popup Entry for Booking Slot
- Booking for Multiple Beneficiaries linked to a Registered Mobile Number
- OTP Regeneration/Validation on Timeout/Session Expiry
- Zero Setup Application, Just Download and Run! Easy to Use!
- No specialized Software required for modification of Config file
- Allow Any Vaccine Type and Any Fee Type for Booking Slots; Remove Mandatory Filters on VaccineType and FeeType
- AI Assisted Auto Captcha
- Application Latest Version Check Automatically before proceeding
- Verbose Mode to be Developed so that user can check each and every step as what is going on behind the scenes when slots are being fetched & processed
- Telemetry Metadata of Booking for Updating Statistics to see how the App is helping others. No Personal Information to be taken.
- Integration of Notification Engine with Telegram Bot
- Native Cross-Platform Support
Technical Details
It's a simple hybrid Console + WinForms Application being developed using .NET Core 3.1, WinForms and C#.
Currently, application is bundled as a Single Standalone Executable EXE file with Runtime included and therefore no installations are needed to run the Application. However, it will only work on Windows Machines only, due to dependency on WinForms for Captcha Popup
In General, to run the application, the following things are needed:
- Windows 7 SP2 or higher where .NET Core 3.1 Runtime is supported, that's it.
.NET Core 3.1 Runtime is bundled in the Release so no other external dependencies to run the Application. FOR DEVELOPERS TO BUILD/MODIFY .NET Core 3.1 SDK is required to build from Source Code or to make some customizations. Use of Visual Studio 2019 is recommended for the purpose of development.
Currently, searching using the calenderByDistrict API and calendarByPin API are integrated to get all the available slots in a particular district/PINCode and to book the slot on First-Come-First-Serve Basis, the appointmentSchedule API is used.
We have got endpoints of both the Public and Protected APIs from APISetu, but a general observation was the Public APIs return stale data as caching is done for around 30 minutes and there is API throttling of 100 requests/5 minutes from 1 IP Address.
Since the slots are gone literally in seconds, so I had to use the Protected APIs for the application.
Well, what's probably going on in your mind is, how do I get the Authentication Information to call the Protected APIs?
We're generating the OTP and then Validating it using the same method as CoWIN App.
On validation of OTP, we get the AuthToken which is further used for the Authentication Purpose.
Rest of the stuff are self-explanatory.
How to Use:
For Folks who just want to get shit done
- Get the Latest Release of the Software either by clicking here or from Releases Section of Github
- Download the ZIP file of the Latest release for your Operating System
- Extract the ZIP file, you'll find two file like this:
- Modify the settings inside
appsettings.json - Double Click
CoWin.Core.exeto RUN the Application.
How to Open appsettings.json
In layman terms, it is just like any other text file which can be opened in any text editor like Notepad, Wordpad, VS Code, Sublime Text, Notepad++ etc. Modification can be done and file to be saved again with the same name and File Types as "All Files"
How to Get User Specific Information for appsettings.json
- Go to
cowin.gov.in - Generate OTP for your registered mobile number. You need to provide this mobile number in the
appsettings.jsonfile. - Validate the OTP
- After you are logged in, you'll see a dashboard like this, get the highlighted number REF ID, which is your beneficary ID and would be required in your
appsettings.json. If you have multiple members added in your registered mobile number, you will get multiple REF IDs. Use the REF IDs for which you want to do booking
- Also, Once all these details are fetched, put them in the
appsettings.json. - Run the Application CoWin.Core.EXE, that's it.
You may also see a file with the name
authToken.jsonin your directory when you are running the Application. This is done so that your session information is stored locally in your device and you don't need to enter OTP manually until 15 minutes, in case you close the Application and run again, it will resume with your previous session. That is possible because of your data stored in thisauthToken.jsonfile. However, that being said this doesn't mean that you don't have to enter OTP. You still have the dependency of entering OTP in the Application, just that if you have to close the Application due to IP Throttling or some other issue, you can resume if your Token is still valid without waiting for a new OTP.
Configuration Changes
The values of the following items MUST BE MODIFIED in appsettings.json
"BeneficiaryIds": [ "REPLACE_WITH_YOUR_BENEFICIARY_ID_1", "REPLACE_WITH_YOUR_BENEFICIARY_ID_2" ]
// You'll get the beneficiary ID from Step 4 above.
// If you have only 1 beneficiary ID then Use it in the <REPLACE_WITH_YOUR_BENEFICIARY_ID_1> section and remove rest like "REPLACE_WITH_YOUR_BENEFICIARY_ID_2" eg. ["1111111111111111"].
// If you have multiple beneficiaries for which you want to do booking, added them comma separated eg. ["11111111111111", "22222222222222", "33333333333333"]
"Mobile": "REPLACE_WITH_YOUR_REGISTERED_MOBILE_NO",
// Use your registered mobile number used for generation of OTP in Step 2 above.
// Use it in the REPLACE_WITH_YOUR_REGISTERED_MOBILE_NO section. Suppose your Mobile Number is 8888333388 then it'll be like "Mobile" : "8888333388".
// *NOTE* Don't use +91 infront of your mobile number, use only 10 digit mobile number
"DoseType": "<REPLACE_ME>", // Use either 1 OR 2 Depending on 1st DOSE or 2nd DOSE in the <REPLACE_ME> section, by default 1 is selected for 1st Dose
"AutoReadCaptcha": "<REPLACE_ME>", // Use either true or false in the <REPLACE_ME> section; By default false;
// True means No need to enter captcha, Captcha will be automatically computed by AI Model, False means captcha needs to be entered manually in the Captcha Popup window
"PINCodes": [
"REPLACE_ME_WITH_YOUR_PIN_CODE_1",
"REPLACE_ME_WITH_YOUR_PIN_CODE_2"
]
// You can use multiple PINCodes for which you wish to search for, examples are of Mumbai and nearby areas.
// If you want to search say for a particular PIN Code of Mumbai let's say 400008 then the entry would look like this : "PINCodes": [ "400008" ].
// Basically, Replace REPLACE_ME_WITH_YOUR_PIN_CODE_1 WITH 400008. and remove everything else.
// In case you want to search for multiple PIN Codes say 400008 and 400007,
// you'll have to remove REPLACE_ME_WITH_YOUR_PIN_CODE_1 with 400008 and REPLACE_ME_WITH_YOUR_PIN_CODE_2 with 40007 and so in, it would look something like this "PINCodes": [ "400008", "400007" ]
The values of the following items MAY BE MODIFIED in appsettings.json, default values are set
Please Note: DO NOT Change or remove to Defaut values if you are not going to use the setting for your Searching of Slot.
"VaccineType": "<REPLACE_ME>", // USE EITHER COVAXIN OR COVISHIELD, OR SPUTNIK V or "" in the <REPLACE_ME> section, by default "" is selected with means any type of Vaccine
"VaccineFeeType": "<REPLACE_ME>", // USE Either Free or Paid or "" in the <REPLACE_ME> section, by default "Free" is selected, blank implies both Free and Paid types
"IsSearchToBeDoneForVaccinationCentreName": "<REPLACE_ME>", // se Either true or false in the <REPLACE_ME> section where true means you want to search for specific Centres within your PINCode/District and false means you don't want to search by CentreName. By default, false is selected
"VaccinationCentreNames": [
"REPLACE_ME_WITH_YOUR_VACCINATION_CENTER_NAME_1",
"REPLACE_ME_WITH_YOUR_VACCINATION_CENTER_NAME_2"
], // You need to put the exact names of the Vaccination Centres for which you want to search in the REPLACE_ME_WITH_YOUR_VACCINATION_CENTER_NAME_1, REPLACE_ME_WITH_YOUR_VACCINATION_CENTER_NAME_2 sections.
// You'll get the names of the Centres from CoWIN Portal. By default all Vaccination Centres in the District/PINCodes are selected. Filter will work only if you set the IsSearchToBeDoneForVaccinationCentreName to true and provide proper exact names of the Centres for which you are searching slots
"IsSearchToBeDoneByPINCode": "<REPLACE_ME>", // Use Either true or false in the <REPLACE_ME> section where True means searching is done using PIN Code, by default true is selected. Set this is True if you want to search By PIN Code
"DateToSearch": "<REPLACE_ME>", // Use date in DD-MM-YYYY Format in the <REPLACE_ME> section, Blank implies date of next day (i.e, tomorrow), by default "" is selected to search for Next Day
"IsSearchToBeDoneByDistrict": "<REPLACE_ME>", // Use Either true or false in the <REPLACE_ME> section where True means searching is done by DistrictId, by default false is selected, Set this is True if you want to search By District
"Districts": [
"REPLACE_ME_WITH_YOUR_DISTRICT_CODE_1",
"REPLACE_ME_WITH_YOUR_DISTRICT_CODE_2"
],
// You'll get District Codes from the link below this block, examples are for Mumbai and nearby districts.
// Basically, Replace REPLACE_ME_WITH_YOUR_DISTRICT_CODE_1 with 395, then the entry would look like this : "Districts": [ "395" ].
// In case you want to search for multiple Districts say Mumbai and Thane, get the District-District Code Mapping from below "State-District-DistrictCode Mapping", // you'll get the DistrictCode of Mumbai as 395 and of Thane as 392.
// You'll have to remove REPLACE_ME_WITH_YOUR_DISTRICT_CODE_1 with 395 and REPLACE_ME_WITH_YOUR_DISTRICT_CODE_2 with 392, it would look something like this "Districts": [ "395", "392"]
"SleepIntervalInMilliseconds": "<REPLACE_ME>", // In the <REPLACE_ME> Section, Use the Time Interval in Milliseconds you want the system to take rest after trying out your Search Criteria of PIN/District/CentreName once. This will help in lessening the chances of getting IP Throttled. Default is 3500
"IsThrottlingToBeUsed": "<REPLACE_ME>", // In the <REPLACE_ME> Section, Use either true or false; By default true; True means IP throttling is there, False means IP throttling has been removed
"ThrottlingThreshold": "<REPLACE_ME>", //In the <REPLACE_ME> Section, Use the Number of requests per IP allowed for ThrottlingInterval. By default it is set to 100
// Say Throttling Interval is 5 minutes and ThrottlingThreshold is 100, that means, you are allowed for 20 Hits from your IP Address per minute.
// Change these values accordingly whenever you face the issue of IP being throlled by Server.
// You may even switch to a different network/IP/Proxy Server so that this can remove the IP Throttling issue for you
"ThrottlingIntervalInMinutes": "<REPLACE_ME>", // In the <REPLACE_ME> Section, use the Interval of Time that is being set for throttling of IP Address. By Default it is // set to 5 which means 5 minutes i.e, in Interval of 5 minutes, 100 requests from your IP Address/Software is allowed. After that you'll receive error unless you switch to another network.
"Proxy":
{
"IsToBeUsed": "<REPLACE_ME>", // Use true or false, true if you are behind Proxy Server, false if you're not, in the <REPLACE_ME> section, by default false would be selected
"Address": "<REPLACE_ME>" // Use the THE PROXY ADDRESS IF YOU ARE BEHIND PROXY SERVER (usually in Office/Corporate Network) in the <REPLACE_ME> Section, by default this will be blank
}
You can get the District Name and District Code Mapping from State-District-DistrictCode Mapping. Just copy the values of the DistrictCode from the file and paste it in the appsettings.json file's {"Districts"} Or, you can refer the readable State-District-DistrictCode Markdown file and get the values of District Codes from there.
Entries in the State-District-DistrictCode Mapping file would be like below. In this case, the DistrictCode will 3, 1 and 2.
"Andaman and Nicobar Islands": {
"Nicobar": 3,
"North and Middle Andaman": 1,
"South Andaman": 2
}
Be default, this is how the appsettings.json would look like this:
{
"CoWinAPI": {
"PublicAPI": {
"FetchCalenderByDistrictUrl": "https://cdn-api.co-vin.in/api/v2/appointment/sessions/public/calendarByDistrict",
"FetchCalenderByPINUrl": "https://cdn-api.co-vin.in/api/v2/appointment/sessions/public/calendarByPin"
},
"ProtectedAPI": {
"IsToBeUsed": true,
"FetchCalenderByDistrictUrl": "https://cdn-api.co-vin.in/api/v2/appointment/sessions/calendarByDistrict",
"FetchCalenderByPINUrl": "https://cdn-api.co-vin.in/api/v2/appointment/sessions/calendarByPin",
"ScheduleAppointmentUrl": "https://cdn-api.co-vin.in/api/v2/appointment/schedule",
"CaptchaGenerationUrl": "https://cdn-api.co-vin.in/api/v2/auth/getRecaptcha",
"BeneficiaryIds": [ "REPLACE_WITH_YOUR_BENEFICIARY_ID_1", "REPLACE_WITH_YOUR_BENEFICIARY_ID_2" ]
},
"Auth": {
"IsToBeUsed": true,
"OTPGeneratorUrl": "https://cdn-api.co-vin.in/api/v2/auth/generateMobileOTP",
"OTPValidatorUrl": "https://cdn-api.co-vin.in/api/v2/auth/validateMobileOtp",
"Secret": "U2FsdGVkX18vDwDor+oOIG7vSUnINtlc/pxQcNiBulCm8LT5Sza+aIISKLqImbpMnRYgsN2QACPhggLWgZEpQg==",
"AutoReadCaptcha": false, // Use either true or false; By default false; True means No need to enter captcha, False means captcha needs to be entered manually
"Mobile": "REPLACE_WITH_YOUR_REGISTERED_MOBILE_NO"
},
"SleepIntervalInMilliseconds": 3500,
"IsThrottlingToBeUsed": true, // Use either true or false; By default true; true means IP throttling is inplace, False means IP throttling has been removed
"ThrottlingThreshold": 100, //Number of request per IP allowed for ThrottlingInterval
"ThrottlingIntervalInMinutes": 5,
"TotalIterations": 10000,
"SelfRegistrationPortal": "https://selfregistration.cowin.gov.in",
"MinAgeLimit": 18,
"MaxAgeLimit": 44,
"MinimumVaccineAvailability": 1,
"VaccineType": "", // Blank Implies Any VaccineType: COVISHIELD OR COVAXIN OR SPUTNIK V; Default is any type of Vaccine
"DoseType": 1,
"VaccineFeeType": "Free", // Blank Implies Any VaccineFeeType: Free or Paid; Default is Free
"IsSearchToBeDoneForVaccinationCentreName": false, // Set this is true if you want to search for specific Centres within your PINCode/District
"VaccinationCentreNames": [
"REPLACE_ME_WITH_YOUR_VACCINATION_CENTER_NAME_1",
"REPLACE_ME_WITH_YOUR_VACCINATION_CENTER_NAME_2"
], // You need to put the exact names of the Vaccination Centres for which you want to search. You'll get that from CoWIN Portal
"IsSearchToBeDoneByPINCode": true, // Set this as true if you want to set by PINCode
"PINCodes": [
"REPLACE_ME_WITH_YOUR_PIN_CODE_1",
"REPLACE_ME_WITH_YOUR_PIN_CODE_2"
],
"IsSearchToBeDoneByDistrict": false, // Set this is true if you want to search By District
"Districts": [
"REPLACE_ME_WITH_YOUR_DISTRICT_CODE_1",
"REPLACE_ME_WITH_YOUR_DISTRICT_CODE_2"
],
"DateToSearch": "" // DD-MM-YYYY Format, Blank implies tomorrow's day; Date Searched is upto 7 days from the date in DateToSearch
},
"Proxy": {
"IsToBeUsed": "false",
"Address": ""
},
"App": {
"LatestVersion": {
"FetchDetailsAPIEndpoint": "https://api.github.com/repos/srvsaha/CoWINVaccineSlotFinder/releases/latest"
}
}
}
As simple as that!
Enjoy and feel free to Star the Repo, if it could help you in any way!
For Developers or Curious Minds:
If you have Visual Studio installed, go ahead an Clone the Repository, Open the SLN file, Make changes in appsettings.json, Ctrl + F5 and Boom! It will do the searching for you, but if you have turned on Auto-Captcha your booking won't work and you'll get System.IO.InvalidDataException exception. Reason for this is that AutoCaptcha needs an Base64 encoded Encrypted Trained Model which will be used for getting the captcha. Since it's not a good practice to HardCode it in Source Code, so it won't work unless you get the Encrypted Model and the Secret Key.
Still curious about that, check out CaptchaModel and Crypto
However the standalone release for Windows has all these dependencies handled so you don't need to worry about anything! Everything will work seamlessly, we got your back!
Well, want to dig deeper?
So basically, you've this Project Named CoWin.Core which contains appsettings.json which performs most of the magic. CoWin.UI is just a small project for handling the Captcha. CoWin.Tests is used for Automated Unit Tests.
Rest of the Business Logic are there inside the /Models directory. Authentication & Authorization stuffs can be found in /Auth directory. API consumption stuffs can be found in /Providers directory. Application begins from Program.cs from the CoWin.Core project.
Clean Coding Practices have been followed during the development of the Application within a span of 2 days after Office Hours. So, you won't find proper Exception Handling, using Dependency Injection or Logging or even Documentation, duh!
I know, I know, it's unacceptable, but folks, it's all about quick Time to Market first and then doing one thing at a time, to improve the product.
I'll be more than happy to have PRs with modifications.
If you'd like to do it the hard way, clone it, build it and run it. Make sure you've the dependencies required to run the Application as mentioned in Technical Details Section
NB: appsettings.json play the major role for accessing and booking and filtration of searches. Fiddle with it! Appologies that the Code doesn't have inline documentation, but code is readable and self explanatory. In case of any suggestions or bugs or feature request, feel free to raise an Issue.
Cheers!
