Skip to main content

Platform & Builders

DZDK CLI for Dzaleka Online Services

Install and use the DZDK command-line client for the public Dzaleka Online Services API

The DZDK CLI is a community-maintained command-line tool for working with public Dzaleka Online Services data from a terminal or script.

Install

The CLI is published on PyPI and needs Python 3.8 or newer:

pip install dzdk

Check it is working:

dzdk health

That reports the status and response time of each public endpoint.

What it is for

Use the CLI when you want to:

  • inspect public collections quickly
  • test API responses from the terminal
  • export data for reporting or analysis
  • script repeatable checks against the public API

Commands

Commands
CommandWhat it does
dzdk healthCheck the status and response time of each public endpoint
dzdk search --query "<text>"Search across services, events, photos, and resources
dzdk services listList published services, 12 per page
dzdk services get <id>Show one service in full
dzdk eventsBrowse published events
dzdk resourcesBrowse published resources
dzdk photosList and upload photos
dzdk populationAccess population data
dzdk statsView statistics and analytics
dzdk export csvExport data to CSV
dzdk export reportGenerate a markdown report
dzdk batchBatch operations for resources and photos
dzdk shellStart an interactive shell
dzdk configConfigure the API URL and request timeout
dzdk show-configPrint the current configuration

Run dzdk <command> --help for the options on any command.

Examples

Search for a service and limit the results:

dzdk search --query "legal aid" --type services --limit 5

List services, then inspect one:

dzdk services list
dzdk services get <id>

Export a collection for analysis:

dzdk export csv

API base URL

The CLI connects to the same public API used by the site:

https://services.dzaleka.com/api

Point it somewhere else, or change the request timeout, with:

dzdk config --url "https://services.dzaleka.com/api" --timeout 30

Source and releases

The CLI is maintained separately from this website:

If you only need the data

If you do not need the CLI itself, you can work directly with:

Get help

Related guides

Get help

If the guide does not answer your question, use the support or contact pages for follow-up help.

Was this page useful?
Add a comment (optional)

Do not include names, phone numbers or other personal information.