networks

API for requests related to networks.

networks

GET https://www.openagua.org/api/v1/networks/:network_id

Get a network, with various options for downloading in different formats and including related data.

Path Parameters

NameTypeDescription

network_id

number

ID of the network to get.

Query Parameters

NameTypeDescription

purpose

string

This is a way of specifying the purpose of the request. If omitted, the normal, JSON-formatted version of the network will be returned. For now, the only option is "download".

format

string

If the purpose is "download", the "format" parameter is used to specify the file format of the download. Options include "json", "csv", "xlsx", "adjacency", "geojson" and "shapefile".

Last updated