GitHub - Orthodox-Union/zmanim-docs

To Get Zmanim Info:

Url: https://db.ou.org/zmanim/getCalendarData.php
Parameters: mode, dateBegin, dateEnd, israel_holidays, candles_offset, havdala_offset, lat, lng, timezone, zipCode, ical, csv, chametz_times, shabbos_times

Name	Description	Format
mode	Specify the mode you want to use	Use year, month, day, or drange
dateBegin	Specify begin date for drange mode, or day / month / year to use for other modes	Date in M/D/Y format
dateEnd	Use only for drange mode to specify end date	Date in M/D/Y format
israel_holidays	(optional) Specify if to use Israel holidays schedule or not	Boolean true/false. Default: false
candles_offset	(optional) Specify amount of time before shkia candle lighting should be	Number. Default: 18
havdala_offset	(optional) Specify amount of time after shkia havdala should be	Number. Default: 42
lat	(optional can be replaced with zipCode) Latitude of the place being searched	Long
lng	(optional can be replaced with zipCode) Longitude of the place being searched	Long
timezone	(optional can be replaced with zipCode) Timezone of the place being searched	Name of the timezone from Olson Database. Example: America/New_York
zipCode	(optional can be replaced with lat/lng/timezone) Zip Code of the place being searched	Valid Zipcode
ical	(optional) Specify if output should be in iCal file	Boolean true/false. Default: false
csv	(optional) Specify if output should be in csv file	Boolean true/false. Default: false
chametz_times	(optional) Specify if to include latest times for eating and burning chametz	Boolean true/false. Default: false
shabbos_times	(optional) Specify if to include extra shabbos times (Havdala and Plag Mincha)	Boolean true/false. Default: false

Uses: https://db.ou.org/zmanim/getCalendarData.php?mode=day&timezone=America/New_York&dateBegin=4/14/2014&lat=40.590034&lng=-73.940101

Returns: JSON

{
   "engDateString":"4\/14\/2014",
   "hebDateString":"14 Nisan 5774",
   "dayOfWeek":"1",
   "zmanim":{
      "tzeis_850_degrees":"20:16:14",
      "sof_zman_tefila_gra":"10:43:49",
      "mincha_ketana_gra":"16:48:17",
      "tzeis_595_degrees":"20:01:59",
      "sof_zman_shema_gra":"09:37:33",
      "sof_zman_tefila_ma":"10:15:16",
      "sof_zman_shema_ma":"08:54:38",
      "mincha_gedola_ma":"13:29:29",
      "talis_ma":"05:27:00",
      "chatzos":"12:56:21",
      "tzeis_42_minutes":"20:15:57",
      "sunset":"19:33:57",
      "plag_mincha_ma":"18:11:07",
      "tzeis_72_minutes":"20:45:57",
      "sunrise":"06:18:44",
      "alos_ma":"04:52:44"
   },
   "candle_lighting":"19:15:00",
   "erev_yomtov":"First Day of Pesach",
   "dafYomi":{
      "masechta":"Beitzah",
      "daf":"15"
   },
   "specialShabbos":false,
   "parsha_shabbos":"Tzav",
   "candle_lighting_shabbos":"18:43:00"
}

To Get Holiday Info:

Url: https://db.ou.org/zmanim/getHolidayCalData.php
Parameters: year, hebrewYear, israelHolidays, callback, php

Name	Description	Format
year	(optional) Specify which year the holidays should be for	YYYY format. Default: this year
hebrewYear	(optional) Specify the hebrew year for rosh chodesh information	YYYY format. If specified, will return rosh chodesh information instead of holiday information
israelHolidays	(optional) Specify if to use Israel holidays schedule or not	Boolean true/false. Default: false
callback	(optional) Used for jsonp response	Function name. If none specified will return json string.
php	(optional) Specify if to return data as serialized php variable	Boolean true/false. If not true will return json string.

Uses:
For Holiday Information:
https://db.ou.org/zmanim/getHolidayCalData.php?year=2014&israelHolidays=true

Returns: JSON

[{
      "name":"TuBShevat",
      "workLvl":8,
      "dateYear1":"Thu Jan 16",
      "dateYear2":"Wed Feb 4"
   },
   {
      "name":"TaanitEsther",
      "workLvl":8,
      "dateYear1":"Thu Mar 13",
      "dateYear2":"Wed Mar 4"
   }, ...]

For Rosh Chodesh Information:
https://db.ou.org/zmanim/getHolidayCalData.php?hebrewYear=5774

Returns: JSON

[{
      "EnglishDate":"March 31",
      "HebrewDate":"29 Adar II",
      "Molad":"3 hours, 54 minutes and 9 chalakim",
      "JewishMonth":"Nissan",
      "DayOfWeek":"Monday"
   },
   {
      "EnglishDate":"April 29",
      "HebrewDate":"29 Nissan",
      "Molad":"16 hours, 38 minutes and 10 chalakim",
      "JewishMonth":"Iyar",
      "DayOfWeek":"Tuesday"
   }, ...]

To Get Geographical Info:

Url: https://db.ou.org/geoip
Parameters: ip, country, city, region, term, limit, format, callback

Name	Description	Format
ip	(optional) Specify ip address	Valid ip address
country	(optional) Specify country name	Use 2-letter country code. Must specify if using city parameter.
city	(optional) Specify city name	Must specify if using country parameter
region	(optional) Specify region(state) name	Can be used with country and city options
term	(optional) Specify term to search for autocomplete data	Mandatory to get autocomplete data. Can be used with limit parameter.
limit	(optional) Specify maximum amount of autocomplete data to return	Number. To be used with term parameter.
format	(optional) Specify format results should be returned in	Use php or json. Default: json
callback	(optional) Used for jsonp	Function name. If none specified will return json string.

Uses:
For Geographical Information:
https://db.ou.org/geoip/?country=US&city=monsey

Returns: JSON

{
   "cc":"US",
   "rc":"NY",
   "cn":"Monsey",
   "pc":"10952",
   "latitude":"41.1181",
   "longitude":"-74.0833",
   "timezone":"America\/New_York"
}

For Autocomplete Data:
https://db.ou.org/geoip/?term=Mon&limit=5

Returns: JSON

[
   "Mon Choisy, MU",
   "Mon Plaisir, BE",
   "Mon Plaisir, GD",
   "Mon Plaisir, TT",
   "Mon Repos, LC"
]

To Get Location Info:

Url: https://db.ou.org/location
Parameters: ip, country, city, region, zipCode, legacy, format, callback

Name	Description	Format
ip	(optional) Specify ip address	Valid ip address
country	(optional) Specify country name	Use 2-letter country code. Must specify if using city parameter.
city	(optional) Specify city name	Must specify if using country parameter
region	(optional) Specify region(state) name	Can be used with country and city options
zipCode	(optional) Specify zip code	Valid postal code in US or CA
legacy	(optional) Specify if to include certain legacy fields (country, region, city, today and hebrewYear)	Use 1 for true.
format	(optional) Specify format results should be returned in	Use php or json. Default: json
callback	(optional) Used for jsonp	Function name. If none specified will return json string.

Uses:
https://db.ou.org/location/?city=Toronto&country=CA

Returns: JSON

{
   "cc":"CA",
   "rc":"BC",
   "cn":"Toronto",
   "pc":"",
   "latitude":"43.6667",
   "longitude":"-79.4167",
   "timezone":"America\/Toronto",
   "date":"03\/12\/2014 09:58:14",
   "community_id":null,
   "israelHolidays":false,
   "candlesOffset":"18",
   "havdalaOffset":"42"
}

To Get Autocomplete Location Info:

Url: https://db.ou.org/location/autocomplete.php
Parameters: term, limit, format, callback

Name	Description	Format
term	Specify term to search for autocomplete data	Any term
limit	(optional) Specify maximum amount of autocomplete data to return	Number.
format	(optional) Specify format results should be returned in	Use php or json. Default: json
callback	(optional) Used for jsonp	Function name. If none specified will return json string.

Uses:
https://db.ou.org/location/autocomplete.php?term=san

Returns: JSON

[
   "San , MX",
   "San Acacia, NM US",
   "San Adri, ES",
   "San Adria Del Bes, ES",
   "San Adrian, ES",
   "San Adri?n De Veiga, ES",
   "San Adri?n, ES",
   "San Agata, IT",
   "San Agust, AR",
   "San Agust, ES"
]

To Get Parsha Info:

Url: https://db.ou.org/zmanim/getParshaData.php
Parameters: date

Name	Description	Format
date	Specify date in week	Date in M/D/Y format

Uses:
https://db.ou.org/zmanim/getParshaData.php?date=2/13/2015

Returns: JSON

{
   "parsha" : "Mishpatim"
}

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

To Get Zmanim Info:

To Get Holiday Info:

To Get Geographical Info:

To Get Location Info:

To Get Autocomplete Location Info:

To Get Parsha Info:

About

Releases

Packages

Contributors 3

Orthodox-Union/zmanim-docs

Folders and files

Latest commit

History

Repository files navigation

To Get Zmanim Info:

To Get Holiday Info:

To Get Geographical Info:

To Get Location Info:

To Get Autocomplete Location Info:

To Get Parsha Info:

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 3

Packages