REST API
Get crowd entries
GET
https://avoid-crowds.dev/api/crowds
This endpoint allows you to get crowd entries.
Query Parameters
Name | Type | Description |
---|---|---|
include | string | Include your region to access crowd entries for that region. An overview of regions can be found under 'additional information'. Single available value: |
sort | string | The sort query parameter is used to determine by which property the results collection will be ordered. Sorting is ascending by default. Adding a hyphen ( |
fields[crowds] | string | Sometimes you'll want to fetch only a couple fields to reduce the overall size of your SQL query. This can be done using the fields query parameter. In case of getting multiple fields, write fields in string format, separated by comma without space after the comma. Available fields for sorting:
|
filter | array | The filter query parameters can be used to filter results by partial property value, exact property value or if a property value exists in a given array of values. There are a lot of flexible filters for crowds below. |
filter[date] | string | Get entries for dates in many different ways. Format of date:
|
filter[days_before] | string | Get entries before current day. Format of date is the same as for |
filter[days_after] | string | Get entries after current day. Format of date is the same as for |
filter[days_between] | string | Get entries between two days. Format of dates is the same as for filter[date]. Two dates must be separated by comma without space after comma. Example: |
filter[region] | string | Filterting entries by parameters in array. Full list of regions can be found on region list page. |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token is API key for full access to Avoid Crowds API. Example string for Authentication header: |
Get crowd entries by region
GET
https://avoid-crowds.dev/api/crowds/{region}
Query Parameters
Name | Type | Description |
---|---|---|
include | string | Include related region for crowd entry. Single available value: |
sort | string | The sort query parameter is used to determine by which property the results collection will be ordered. Sorting is ascending by default. Adding a hyphen (-) to the start of the property name will reverse the results collection. In case of sorting by multiple fields, write the fields in string format, separated by comma without space. Available fields for sorting:
|
fields[crowds] | string | In case you want to fetch only a couple fields to reduce the overall size of your SQL query. This can be done using the fields query parameter. In case of getting multiple fields, write fields in string format, separated by comma without a space after the comma. Available fields for sorting:
|
filter | array | The filter query parameters can be used to filter results by partial property value, exact property value or if a property value exists in a given array of values. There are a lot of flexible filters for crowds below. |
filter[date] | string | Get entries for dates in many differents ways. Format of date:
|
filter[days_before] | string | Get entries before passed day. Format of date is the same as for |
filter[days_after] | string | Get entries after passed day. Format of date is the same as for |
filter[days_between] | string | Get entries between two days. Format of dates is the same as for filter[date]. Two dates must be separated by comma without a space after the comma. Example: |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token is API key for full access to Avoid Crowds API. Example string for Authentication header: |
Get public holidays
GET
https://avoid-crowds.dev/api/public_holidays
Query Parameters
Name | Type | Description |
---|---|---|
filter[source] | string | Get entries filtered by source |
filter[provinces] | string | Get entries filtered by provinces |
filter[scope] | string | Get entries filtered by scope |
filter[name] | string | Get entries filtered by name |
filter[country] | string | Get entries filtered by country |
sort | string | The sort query parameter is used to determine by which property the results collection will be ordered. Sorting is ascending by default. Adding a hyphen (-) to the start of the property name will reverse the results collection. In case of sorting by multiple fields, write the fields in string format, separated by comma without space. Available fields for sorting:
|
filter | array | The filter query parameters can be used to filter results by partial property value, exact property value or if a property value exists in a given array of values. There are a lot of flexible filters for crowds below. |
filter[date] | string | Get entries for dates in many differents ways. Format of date:
|
filter[days_before] | string | Get entries before passed day. Format of date is the same as for |
filter[days_after] | string | Get entries after passed day. Format of date is the same as for |
filter[days_between] | string | Get entries between two days. Format of dates is the same as for filter[date]. Two dates must be separated by comma without a space after the comma. Example: |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token is API key for full access to Avoid Crowds API. Example string for Authentication header: |
Get school vacations
GET
https://avoid-crowds.dev/api/school_vacations
Query Parameters
Name | Type | Description |
---|---|---|
filter[source_official] | string | Get entries filtered by source official |
filter[provinces] | string | Get entries filtered by provinces |
filter[scope] | string | Get entries filtered by scope |
filter[description] | string | Get entries filtered by name |
filter[country] | string | Get entries filtered by country |
sort | string | The sort query parameter is used to determine by which property the results collection will be ordered. Sorting is ascending by default. Adding a hyphen (-) to the start of the property name will reverse the results collection. In case of sorting by multiple fields, write the fields in string format, separated by comma without space. Available fields for sorting:
|
filter | array | The filter query parameters can be used to filter results by partial property value, exact property value or if a property value exists in a given array of values. There are a lot of flexible filters for crowds below. |
filter[date] | string | Get entries for dates in many differents ways. Format of date:
|
filter[days_before] | string | Get entries before passed day. Format of date is the same as for |
filter[days_after] | string | Get entries after passed day. Format of date is the same as for |
filter[days_between] | string | Get entries between two days. Format of dates is the same as for filter[date]. Two dates must be separated by comma without a space after the comma. Example: |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token is API key for full access to Avoid Crowds API. Example string for Authentication header: |
Last updated