API Documentation

1. Search for Datasets

Endpoint: /api/3/action/package_search

Description: Search for datasets in the CKAN instance.

Parameters:

q: Search query (optional).
rows: Number of records to return (optional, default is 10).
start: Record number to start the search (optional, default is 0).

Example: https://www.idpo.org.au/api/3/action/package_search?q=misinformation&rows=5

2. Get Dataset Metadata

Endpoint: /api/3/action/package_show

Description: Retrieve metadata for a specific dataset.

Parameters:

id: Dataset ID or name (required).

Example: https://www.idpo.org.au/api/3/action/package_show?id=misinformation

3. Get Resource Data

Endpoint: /api/3/action/datastore_search

Description: Retrieve data from a specific resource.

Parameters:

resource_id: The resource ID (required).
q: Search query (optional).
limit: Number of records to return (optional).

Example: https://www.idpo.org.au/api/3/action/datastore_search?resource_id=6d9707a7-475b-4e9b-a6f6-6b8ec5e8a0b1&limit=5

4. Get Resource Metadata

Endpoint: /api/3/action/resource_show

Description: Retrieve metadata for a specific resource.

Parameters:

id: Resource ID (required).

Example: https://www.idpo.org.au/api/3/action/resource_show?id=6d9707a7-475b-4e9b-a6f6-6b8ec5e8a0b1

Get Resource Metadata

You can use tools like curl, Postman, or any HTTP client in your programming language of choice to make requests to these endpoints.
For example, using curl:


    curl -s "https://www.idpo.org.au/api/3/action/package_search?q=misinformation&rows=5"

Parsing API Responses

API responses are typically in JSON format. You can parse the responses to extract the data or metadata you need. For example, in Python:


    import requests

    url = "https://www.idpo.org.au/api/3/action/package_search?q=misinformation&rows=5"
    response = requests.get(url)
    data = response.json()
    print(data)

IDPO