Skip to content

Latest commit

 

History

History

routes

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

API Documentation

There's a table of api routes below

Method Route Required Params Description More Example Calls
GET / - Application healCheck route, it also check availability of time.ir at first Click
GET /datetime - Returns current time, with 3 seperate dates [Shamsi, gregorian, Hijri] Click Click
GET /events [year, month, day] Returns an array of events related to that day. Note: all parameters for this routes should be shamsi. Click Click
GET /events/month [year, month] Returns an array of events related to requested month. Note: all parameters for this routes should be in shamsi. Click Click
GET /convert [year, month, day, type] Returns a converted date based on entered value of type. accepted values for type are [jalali, gregorian, hijri]. Attention: type parameter should matches you other params. means that if yeah,month,day is in jalali type should be jalali as well. Click Click
GET /azan/times [province, city] Returns Azan times based on the requested city. keys number for each city and province can be found on /azan/cities route. Click Click
GET /cities - Returns cities and province names and keys. which should use the keys to get Azan times for a city Click Click