{"id":18098577,"url":"https://github.com/makiftutuncu/muezzinapi","last_synced_at":"2025-04-13T12:52:18.348Z","repository":{"id":35921051,"uuid":"40208857","full_name":"makiftutuncu/MuezzinAPI","owner":"makiftutuncu","description":"A web server application for Islamic prayer times","archived":false,"fork":false,"pushed_at":"2023-12-15T14:46:07.000Z","size":1316,"stargazers_count":34,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T12:52:12.230Z","etag":null,"topics":["actors","akka","firebase","islamic-prayer-times","playframework","prayer-times","scala"],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/makiftutuncu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2015-08-04T21:00:52.000Z","updated_at":"2022-11-26T16:02:36.000Z","dependencies_parsed_at":"2023-12-15T15:54:56.972Z","dependency_job_id":null,"html_url":"https://github.com/makiftutuncu/MuezzinAPI","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2FMuezzinAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2FMuezzinAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2FMuezzinAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2FMuezzinAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/makiftutuncu","download_url":"https://codeload.github.com/makiftutuncu/MuezzinAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248717259,"owners_count":21150388,"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","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":["actors","akka","firebase","islamic-prayer-times","playframework","prayer-times","scala"],"created_at":"2024-10-31T20:11:54.822Z","updated_at":"2025-04-13T12:52:18.327Z","avatar_url":"https://github.com/makiftutuncu.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"Muezzin API\n=================================\n\nWelcome to Muezzin API web service!\n\nThis application provides Islamic prayer times for more than 200 countries, their cities and many of their districts. Data is read from Republic of Turkey, Presidency of Religious Affairs' [**website**](http://www.diyanet.gov.tr) and provided in a simple JSON structure.\n\nThe application will be running at **https://muezzin-staging.herokuapp.com**.\n\nTechnical Details\n--------------\nMuezzin API application is developed using [**Play Framework**](https://www.playframework.com/) and [**Scala**](http://www.scala-lang.org/). The application utilizes [**Akka Actors**](http://akka.io/) actors for scheduling jobs, [**WS**](https://www.playframework.com/documentation/latest/ScalaWS) for making HTTP requests, [**Firebase Realtime Database**](https://firebase.google.com/docs/database/) for data persistance and [**Errors**](https://github.com/mehmetakiftutuncu/Errors) for error handling.\n\nDeploying Muezzin API to AWS ElasticBeanstalk\n-------------\nAdd host of your EB host to [application.conf](conf/application.conf) under `play.filters.hosts.allowed`. Here's an example:\n```\nplay {\n  filters.hosts {\n    allowed = [\n      \"muezzin.123456.eu-west-1.elasticbeanstalk.com\",\n      \"muezzin.herokuapp.com\",\n      \"muezzin-staging.herokuapp.com\",\n      \"localhost:9000\"\n    ]\n  }\n}\n```\n\nThen run `sbt elastic-beanstalk:dist` to create ZIP file that you can upload to your ElasticBeanstalk.\n\nThanks [@gokhanayhan38](https://github.com/gokhanayhan38) for his help.\n\nAPI Reference\n-------------\n\n### General\n* All endpoints use `GET` method.\n* When a request is successful, response will be `200 OK` with `application/json` as `Content-Type` and the requested data in body.\n* When a request fails, response will be `503 SERVICE_UNAVAILABLE` with `application/json` as `Content-Type` and error data in body according to [**Errors**](https://github.com/mehmetakiftutuncu/Errors). \n\n##### Example Response With Errors\n```json\n{\n  \"errors\": [\n    {\n      \"name\": \"requestFailed\",\n      \"reason\": \"Diyanet returned invalid content type.\",\n      \"data\": \"applocation/xml\"\n    }\n  ]\n}\n```\n\n* Each object in `errors` array will correspond to a single error. There may be 1 or more error objects.\n* `name` will be provided for all types of errors whereas `reason` and `data` might not be available for all errors.\n\n***\n\n### Countries\n#### GET: [`/countries`](https://muezzin-staging.herokuapp.com/countries)\nIt returns available countries.\n\n##### Example Response\n```\n{\n  \"countries\": {\n    \"2\": {\n      \"name\": \"Turkey\",\n      \"nameTurkish\": \"Türkiye\",\n      \"nameNative\": \"Türkiye\"\n    }\n  }\n}\n```\n\n* Every key in `countries` object is the id for the country in the value object.\n* `name` is the name of country in English.\n* `nameTurkish` is the name of the country in Turkish.\n* `nameNative` is the name of the country in their native language.\n\n***\n\n### Cities\n#### GET: [`/countries/\u003ccountryId\u003e/cities`](https://muezzin-staging.herokuapp.com/countries/2/cities)\nIt returns available cities of given `countryId`.\n\n##### Example Response\n```json\n{\n  \"cities\": {\n    \"540\": {\n      \"name\": \"İzmir\"\n    }\n  }\n}\n```\n\n* Every key in `cities` object is the id for the city in the value object.\n* `name` is the name of the city.\n\n***\n\n### Districts\n#### GET: [`/countries/\u003ccountryId\u003e/cities/\u003ccityId\u003e/districts`](https://muezzin-staging.herokuapp.com/countries/2/cities/540/districts)\nIt returns available districts of given `cityId` of `countryId`. Please note that some cities might not have districts available.\n\n##### Example Response\n```json\n{\n  \"districts\": {\n    \"9552\": {\n      \"name\": \"Aliağa\"\n    }\n  }\n}\n```\n\n* Every key in `districts` object is the id for the district in the value object.\n* `name` is the name of the district.\n\n***\n\n### Prayer Times\n#### GET: [`/prayerTimes/country/\u003ccountryId\u003e/city/\u003ccityId\u003e/district/\u003cdistrictId\u003e`](https://muezzin-staging.herokuapp.com/prayerTimes/country/2/city/540/district/9560)\nIt returns prayer times for a month belonging to given `countryId`, `cityId` and `districtId`. Please note that there are no times available for past dates and more than 1 month future dates. Diyanet only provides 1 month of prayer times starting from current time. Therefore, it is client's responsibility to keep requested prayer times and request more whenever needed.\n\n##### Example Response\n```json\n{\n  \"prayerTimes\": {\n    \"2016-08-23\": {\n      \"fajr\": \"04:56\",\n      \"shuruq\": \"06:26\",\n      \"dhuhr\": \"13:21\",\n      \"asr\": \"17:02\",\n      \"maghrib\": \"20:03\",\n      \"isha\": \"21:26\",\n      \"qibla\": \"12:00\"\n    }\n  }\n}\n```\n\n* Every key in ``prayerTimes`` object is the date for the prayer times in the value object. Dates are formatted as: `yyyy-MM-dd`\n* `fajr`, `shuruq`, `dhuhr`, `asr`, `maghrib`, `isha` and `qibla` are times formatted as `HH:mm`, representing the named times respectively.\n* `qibla` is set to `00:00` when it is not available.\n\n***\n\nLicense\n--------------\nMuezzin API is licensed under the terms of the MIT License.\n\n```\nMIT License\n\nCopyright (c) 2017 Mehmet Akif Tütüncü\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakiftutuncu%2Fmuezzinapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmakiftutuncu%2Fmuezzinapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakiftutuncu%2Fmuezzinapi/lists"}