1. The widget (one line)
Paste this where the box should appear. It shows the nearest shuls, each with its next Shacharis time, distance and address, and links to the shul on our site.
Live preview
Options: data-zip (US ZIP) or data-city (e.g. Paris, Lakewood, Toronto) or data-lat + data-lng; data-limit 1–20; data-theme light, dark or auto; data-size small or large; data-units mi or km; data-radius in miles (default 60); data-search="false" hides the small search box; data-target="id" fills an element you already have.
The widget draws inside its own sealed box (shadow DOM), so it can't change your page's styles and yours can't break it. It sets no cookies, stores nothing and tracks no one. It is about 18 KB.
2. Or an iframe
For site builders that don't allow scripts (Wix, Squarespace blocks, some CMS editors):
The same options work as URL parameters: zip, city, lat, lng, limit, theme, size, units, radius, search. Optional auto-height: the frame sends its height with postMessage({bkWidgetHeight}); add the line below the iframe to use it.
3. The data feed (API)
Plain JSON files. No key, no sign-up, readable from any website (CORS open). Updated with the directory, normally every hour.
| File | What |
|---|---|
/api/v1/index.json | Version, last update, counts per country and state, links |
/api/v1/shuls.json | Every shul (about 950) |
/api/v1/countries/us.json | One country (ISO code, lower case: us, fr, ca, gb, mx…) |
/api/v1/states/US-NJ.json | One US state or Canadian province (US-NY, CA-ON…) |
/api/v1/schema.json | JSON Schema of one shul |
/api/v1/widget.json | Compact copy the widget reads (may change without notice; use the files above) |
Example
Fields of a shul
id | Stable id, e.g. SD-0948 |
name, address, city, state, state_code, zip, country, country_code | Where it is |
lat, lng, location_precision | Map point; "approx" means a street or area estimate |
timezone | The shul's time zone. All times are local times at the shul. |
nusach, labels | E.g. "Edut HaMizrach", "Teimani (Shami)" |
shacharis | Times exactly as listed: sunday, weekdays, shabbos, rosh_chodesh, fast_days, chol_hamoed, yom_tov. null = not listed. Yom Tov is never filled in from Shabbos. |
netz | Netz (sunrise) minyan with its time computed for the stated date |
times_source | Where the times come from: name, link, date |
shul_website_times | Times read from the shul's own website, with the page and the date read |
conflicts | When sources disagree, every value is listed with its source and date. We don't pick a winner. A value from the directory's private list shows as withheld. |
status | Confirmed, Uncertain, Stale or Unverified |
source_date, last_checked | When the source was dated, and when we last checked it |
website, godaven_url, url | The shul's site, its GoDaven page, and its page on our directory |
Terms
- Free. For any website, app or newsletter, at no cost.
- Credit required. Keep "Powered by Bircas Kohanim Directory" with its link (the widget already shows it). When you use the data feed, show the same credit and link.
- Data may change. Shuls change times; the feed and its format can change too. Version 1 stays at
/api/v1/. - Confirm with the shul. Times come from public listings and the shuls' own sites and can be out of date. Tell your readers to confirm times with the shul. No warranty.
- Please cache the files (an hour is plenty) rather than fetching them on every page view.
Corrections? Use "Suggest an update" on the shul's page in the directory.