OpenAgua
  • What is OpenAgua?
  • How to use
    • User Guide
      • Key concepts
      • Sharing & collaboration
      • Configuration
        • Model engines & cloud computing
        • Network templates
      • Setting up a model
        • First steps
        • Viewing/editing a network
        • Viewing/editing scenarios
        • View/edit data
      • Running a model
      • Viewing & saving results
        • Visualize results
        • Results dashboard
        • Exporting results
      • Advanced
        • OpenAgua data specifications
        • Advanced data tools
    • WaterLP
      • Getting started
      • Built-in variables
      • Functions reference
    • Where to get help
    • Frequently Asked Questions
    • Web API
      • networks
  • Learn more
    • Publications
    • The Team
    • Development
      • Open source software
      • Contributing
Powered by GitBook
On this page
  1. How to use
  2. Web API

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

Name
Type
Description

network_id

number

ID of the network to get.

Query Parameters

Name
Type
Description

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".

PreviousWeb APINextPublications

Last updated 4 years ago