Skip to content

Venues

Get a venue

A venue's address, location, time zone, opening hours and menu languages, and whether it would take an order right now.

GET/public/v1/venues/{venueId}
Authentication

An API key in the X-Api-Key header

Permission
Can read the menu (every key has it)
Rate limit
About 120 requests a minute per key

ordering.acceptingOrdersNow is worked out on every call. It is true when the venue's subscription is active, it has not declared a rush, and it is inside its opening hours (with the grace the venue allows either side). When it is false, ordering.busyUntil is set for a rush and null for a closed venue.

Show or hide your site's order button by it; placing the order checks again, since the state can change between the two calls. More in Venues and branches.

Parameters

venueIdstring · uuidPath parameterrequired

The venue, one of the ids GET /venues lists.

Accept-LanguagestringHeader

The language of userMessage in an error: tr (the default), en, de, fr, it, es, ar or ru. The first language in the header decides, without its region (en-US reads as en) and without weighing q values; a language Cibusy does not offer is answered in Turkish. It does not choose the language of a menu: that is lang on the menu call.

Responses

200

The venue's details.

401

The X-Api-Key header is missing (PUBLIC_API_KEY_MISSING), or the key is invalid or has been revoked (PUBLIC_API_KEY_INVALID).

403

The key may not make this call (PUBLIC_API_SCOPE_MISSING). Every key made in the venue's panel may read venues, menus and tables.

404

The venue does not exist, or this key cannot reach it (PUBLIC_API_VENUE_NOT_FOUND).

429

The key's budget of about 120 requests a minute is spent; wait Retry-After seconds.

Retry-After

Seconds to wait. The next one-minute window opens within it.

The data of a successful answer

Everything a venue's own website needs to introduce the venue and to know whether it is taking orders: the summary plus its address, hours, languages and ordering state.

idstring · uuid

The venue's id. Every call that is about one venue takes it in the path.

namestring

The venue's name as its guests know it.

usernamestringnullable

The username of the venue's page on Cibusy, the one in its menu link (cibusy.com/modakofte). null when the venue has not picked one.

typestring

Whether the venue is independent, a headquarter or a branch.

Independent
An independent venue: no branches, no headquarter.
Headquarter
A headquarter: its key reaches each of its active branches.
Branch
A branch: its key reaches this branch only, never its headquarter or another branch.
parentVenueIdstring · uuidnullable

The id of the headquarter a branch belongs to. null for every venue that is not a branch. A key made for a branch cannot read its headquarter, so the id is for telling a chain's venues apart, not for a call.

logoUrlstringnullable

The address of the venue's logo. null when the venue has not uploaded one.

addressobject

Where the venue is, in words.

Fields of Address
linestringnullable

The street address the venue entered. null when it entered none.

districtstringnullable

The district's name. null when the venue's district is no longer on file.

citystringnullable

The city's name. null when the venue's city is no longer on file.

countrystringnullable

The country's name. null when the venue's country is no longer on file.

locationobjectnullable

Where the venue is on the map. null when the venue has not entered its coordinates.

Fields of Location
latitudenumber

Degrees north of the equator, between -90 and 90.

longitudenumber

Degrees east of the prime meridian, between -180 and 180.

timeZonestring

The venue's time zone as an IANA name (Europe/Istanbul). The opening hours, ordering.opensAt and ordering.closesAt are clock times in this zone.

workingHoursobject[]

The opening hours the venue has entered, Monday first. A day the venue has not entered is not listed, and the venue is not judged against the clock on that day.

Fields of Working hours
daystring

The day of the week.

Values:SundayMondayTuesdayWednesdayThursdayFridaySaturday

opensAtstringnullable

When the venue opens, HH:mm on the venue's clock. null when it is closed that day.

closesAtstringnullable

When the venue closes, HH:mm on the venue's clock. Earlier than opensAt when the venue trades past midnight, and then it is the next morning. null when it is closed that day.

isClosedboolean

true when the venue is shut that whole day.

orderingobject

Whether the venue would take an order right now, and the clock behind the answer. Worked out on every call.

Fields of Ordering state
acceptingOrdersNowboolean

true when an order placed right now would be accepted by the venue's own rules: its subscription is active, it has not declared a rush, and it is inside its opening hours (with the grace the venue allows either side; the rule can be switched off, and a day the venue has not entered is never judged). When it is false, busyUntil tells a rush from a closed venue. Check again by placing the order: this can change between the two calls.

opensAtstringnullable

Today's opening time, HH:mm on the venue's clock, when the venue enforces its hours and has entered some for today. null otherwise, and always null while the venue is busy.

closesAtstringnullable

Today's closing time, HH:mm on the venue's clock. Earlier than opensAt when the venue trades past midnight. null under the same conditions as opensAt.

busyUntilstring · date-timenullable

The moment, in UTC, a rush the venue declared ends. When it is set the venue is open but its kitchen takes no orders until then, so a page can count down to it rather than say "closed". null when there is no rush.

busyReasonstringnullable

What the venue wrote about its rush, a sentence meant for its guests. null when there is no rush or the venue gave no reason.

languagesobject[]

The languages the venue's menu is offered in, its default first. The menu endpoint takes any of their codes as lang. Empty for a venue that has set none up, whose menu then comes only as written.

Fields of Language
codestring

The language's two-letter ISO 639-1 code, the value the menu endpoint's lang takes.

namestring

The language's name, for a language picker.

isDefaultboolean

true for the language the menu comes in when no lang is asked for.

currencystring

The currency of every price, an ISO 4217 code. Always TRY; prices include VAT.