2022
Texas State Water Plan

About

API Documentation

This page contains documentation for the application programming interface (API) that powers the interactive state water plan application. All methods are available via standard HTML requests and are CORS-enabled so that cross-browser requests can be made. All water volumes are given in units of acre-feet/year. Unless otherwise specified, all methods return JSON responses.

For any questions regarding the data or how to apply it, please contact: WRPdatarequests@twdb.texas.gov.

Data Methods

Methods to retrieve raw and summary water planning data.

  • GET /api/v1/data/statewide

    Get all water planning data and summaries.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/statewide/regionalsummary

    Get regional summary data by water usage type.

  • GET /api/v1/data/region/{regionLetter}

    Get water planning data and summaries for the region identified by {regionLetter}.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/county/{countyName}

    Get water planning data and summaries for the county identified by {countyName}.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/entity/{entityId}

    Get water planning data and summaries for the entity identified by {entityId}.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/source/{sourceId}

    Get water source data and summaries for the water source identified by {sourceId}.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/usagetype/{usageType}

    Get water planning data and summaries for all entities of the usage type identified by {usageType}.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/project/{projectId}

    Get project data and summaries for the project identified by {projectId}.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/wms/{wmsId}

    Get WMS data based on WMS Id.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

  • GET /api/v1/data/wmstype/{wmsType}

    Get WMS type data based on WMS Type.

    Notes: Setting the query string to omitRows=truewill omit raw data rows.

Entities Methods

Methods to retrieve entity (water user group) information.

Places Methods

Methods to retrieve places (regional water planning areas, counties, etc.) information.

Sources Methods

Methods to retrieve ground and surface water source information.

  • GET /api/v1/sources

    Get all ground and surface water sources.

  • GET /api/v1/sources/{sourceId}

    Get the water source identified by {sourceId}.

  • GET /api/v1/sources/search

    Find a ground or surface water source by name or partial name.

    Notes: Use the name={nameOrPartial} query parameter to provide a name or partial name.

  • GET /api/v1/sources/geojson

    Get all ground and surface water sources as multiple singlepart geometry records in a GeoJSON formatted response.

  • GET /api/v1/sources/geojson/{sourceId}

    Get the water source identified by {sourceId} as multiple singlepart geometry records in a GeoJSON formatted response.

Projects Methods

Methods to retrieve water management strategies projects information.

WMS Methods

Method to retrieve water management strategies

WmsType Methods

Method to return water management strategies by type