- Home
- API
API documentation
The portal exposes the CKAN Action API as it is. Read endpoints need no key; write operations require an institutional account and a token.
Overview
All endpoints live under <code>/api/3/action/</code> and return JSON. A successful response carries "success": true and the payload under "result".
GET https://acikveri-konya.digitalcosmonot.com/en/api/3/action/package_search?q=trafik&rows=10
Authentication
Read endpoints are open to everyone and need no key. For write operations create an API token from your profile page and send it in the Authorization header.
curl -H "Authorization: <API-TOKEN>" \
https://acikveri-konya.digitalcosmonot.com/en/api/3/action/package_create -d @dataset.json
/api/3/action/package_search
Searches datasets in the catalogue with the Solr query language. Results are paginated; every record carries the full metadata and the resource list.
| Name | Type | Description |
|---|---|---|
| q | string | Free text query. Default *:* |
| fq | string | Filter query, e.g. groups:hareketlilik |
| rows | int | Records per page (max 1000) |
| start | int | Pagination offset |
| sort | string | Sort order, e.g. metadata_modified desc |
/api/3/action/package_show
Returns a single dataset with all of its metadata and resources.
| Name | Type | Description |
|---|---|---|
| id | string | Dataset name or id |
/api/3/action/datastore_search
Queries the rows of a resource stored in the DataStore.
| Name | Type | Description |
|---|---|---|
| resource_id | string | Resource id |
| q | string | Full text query |
| limit | int | Number of rows (default 100) |
| offset | int | Pagination offset |
| fields | string | Comma separated column list |
/api/3/action/datastore_search_sql
Runs a read-only SQL query against DataStore tables.
| Name | Type | Description |
|---|---|---|
| sql | string | SELECT statement; write statements are rejected |
/api/3/action/organization_list
Lists the organizations publishing on the portal.
| Name | Type | Description |
|---|---|---|
| all_fields | bool | Return the full record instead of names only |
| sort | string | Sort order, e.g. package_count desc |
/api/3/action/group_list
Lists the groups (categories).
| Name | Type | Description |
|---|---|---|
| all_fields | bool | Return the full record instead of names only |
/api/3/action/tag_list
Lists the tags used across the catalogue.
| Name | Type | Description |
|---|---|---|
| query | string | Filter tags containing this text |
{
"success": true,
"result": {
"count": 32,
"results": [
{
"name": "trafik-isiklari-konum-bilgisi",
"title": "Trafik Işıkları Konum Bilgisi",
"organization": { "name": "ulasim-dairesi-baskanligi" },
"license_id": "cc-by",
"metadata_modified": "2026-03-06T10:54:12",
"resources": [
{ "format": "CSV", "name": "2025_konya_kavsaklar.csv" },
{ "format": "CSV", "name": "2022_konya_kavsaklar.csv" }
]
}
]
}
}
Invalid parameter
Record not found
Not authorized