Skip to main content

API documentation

Reach the portal's datasets straight over HTTP, without downloading a file. No authentication is required; every endpoint offers public read access.

Base address

https://ckan.buyukverianalitigi.com/api/3/action/

Every response is UTF-8 JSON and uses the same envelope:

{
  "success": true,
  "result": { ... }
}

On failure "success" is false and an "error" object is returned. The HTTP status code may differ from 200.

Downloading all the data

To take a whole resource without paging, use the dump endpoints:

GET https://ckan.buyukverianalitigi.com/datastore/dump/<kaynak-id>?format=csv
GET https://ckan.buyukverianalitigi.com/datastore/dump/<kaynak-id>?format=json
GET https://ckan.buyukverianalitigi.com/datastore/dump/<kaynak-id>?format=xml
GET https://ckan.buyukverianalitigi.com/datastore/dump-xlsx/<kaynak-id>

The XLSX endpoint is specific to this portal; the other three are the DataStore's standard output.

Usage limits

Authentication Not needed. No API key or membership is required.
Permitted operations Read only. Creating, updating and deleting data is closed from outside the portal.
Request limit 60 requests per minute on the query endpoints and 6 per minute on the bulk download endpoints, per IP. There is no daily quota; the limit exists to protect system resources.
When the limit is exceeded The request is answered with HTTP 429; the response's Retry-After header says how many seconds to wait.
Records per request Without a limit parameter the default number of records is returned; the number of records one request can take is capped by the system. For more, page with offset or use the bulk download endpoint.

Querying the catalogue

To search the datasets themselves (their metadata):

GET https://ckan.buyukverianalitigi.com/api/3/action/package_search?q=istasyon&rows=10
GET https://ckan.buyukverianalitigi.com/api/3/action/package_show?id=<veri-seti-adı>
GET https://ckan.buyukverianalitigi.com/api/3/action/group_list?all_fields=true

package_search supports every filter in the interface; by category, for instance:

GET https://ckan.buyukverianalitigi.com/api/3/action/package_search?fq=groups:ulasim