Этот раздел содержит информацию для разработчиков или журналистов, которые плотно работают с данными и знают как минимум основы дата-журналистики. Если Вы ищете базовую информацию про то, как пользоваться порталом, то вам в глоссарий.
Данные можно скачать, следить за их обновлениями, редактировать/улучшать и сравнивать
Данные можно скачать в виде файлов Excel/CSV или можно обращаться к ним через API. Платформа имеет публичный API, с помощью которого можно получать информацию о размещенных данных, использовать данные во внешних приложениях и отслеживать изменения.
Dataset API
site_read
Возвращает true если API платформы доступно для чтения.
Демо: http://opendata.by/api/3/action/site_read
data.json
Больше информации здесь.
Демо: http://opendata.by/data.json
revision_list
Возвращает список ID версий ресурсов.
Демо: http://opendata.by/api/3/action/revision_list
package_list
Возвращает список ID наборов данных.
Демо: http://opendata.by/api/3/action/package_list
current_package_list_with_resources
Возвращает список наборов данных и их ресурсов.
Демо: http://opendata.by/api/3/action/current_package_list_with_resources
package_show
Возвращает метаданные о датасете и его ресурсах.
Демо: http://opendata.by/api/3/action/package_show?id=98e62ecb-c73c-4333-8a6f-...
package_revision_list
Возвращает список версий (revisions) набора данных.
Демо: http://opendata.by/api/3/action/package_revision_list?id=98e62ecb-c73c-4...
resource_show
Возвращает метаданные о ресурсе.
Демо: http://opendata.by/api/3/action/resource_show?id=33ea55fa-b88d-4f11-aaf8...
group_list
Возвращает список групп (тематических хабов).
Demo: http://opendata.by/api/3/action/group_list?order_by=name&all_fields=TRUE
group_package_show
Возвращает ID наборов данных, принадлежащих группе (тематическому хабу).
Демо: http://opendata.by/api/3/action/group_package_show?id=77cbbc83-55ab-4eba...
Datastore API
С помощью Datastore API можно опрашивать хранилище данных, получать результаты, фильтровать их и осуществлять полнотекстовый поиск по ресурсам и датасетам.
Хранилище данных опрашивается по URL http://http://opendata.by/api/action/datastore/search
Параметры запроса
| Параметр | Описание |
|---|---|
| resource_id (mixed) | ID ресурса в виде строки, или ID нескольких ресурсов в виде массива, по которым идет поиск |
| filters (mixed) | массив или строка условий, по которым делается выборка |
| q (string) | полнотекстовый запрос |
| offset (int) | оффсет по кол-ву строк |
| limit (int) | максимальное кол-во строк на возврат. Значение по умолчанию: 100 строк |
| fields (array or comma separated string) | возвращаемые поля. Значение по умолчанию: все поля в изначальном порядке |
| sort (string) | сортировка по названиям полей, указываемых через запятую |
| join (array) | массив полей для выборки данных из нескольких ресурсов одновременно |
Возвращаемые значения
| Значение | Описание |
|---|---|
| fields (list of fields) | поля, колонки и их метаданные |
| offset (int) | значение оффсета |
| limit (int) | значение ограничения (максимального кол-ва строк) в запросе |
| count (int) | кол-во возвращенных по запросу записей |
| records (list of dictionaries) | список результатов запроса |
Примеры запросов
В качестве примера используем этот ресурс http://opendata.by/dataset/12/resource/ff1c9bfe-0e9c-482a-a5c3-a13c4d14a5a5. ID ресурса выделен жирным шрифтом.
GET http://opendata.by/api/action/datastore/search.json?resource_id=ff1c9bfe-0e9c-482a-a5c3-a13c4d14a5a5&filters[date]=1964,1965,1966,1967,1968,1969&fields=date
Выбираем массив значений из поля date.