Routes
- api.ecoatlas.org/{region_type_key}
- api.ecoatlas.org/projects/{region_type_key}/{region_key}
- api.ecoatlas.org/projects/group/?q={group_name}
- api.ecoatlas.org/projects
- api.ecoatlas.org/project/{projectid}
EcoAtlas tracks projects that modify habitat, such as wetland or stream restoration, compensatory mitigation, or habitat conservation. Multiple programs are using Project Tracker’s online data entry/edit forms (ptrack.ecoatlas.org) to manage their project information. Projects may have have multiple sites, activities, contacts, and funders.
Projects can be viewed in the landscape context along with other data layers on an interactive map. Individual project information pages summarize the status, events, contacts, funding, and habitat plan for each project. Supporting materials, including monitoring reports, permits, photos, videos, and links to other websites, can be stored in a project’s file repository. In addition, dynamic visualizations help measure the cumulative benefits of public policies and programs for California's aquatic resources.
Provides a list of all queryable regions within the given region type. Currently supported region types include ecoregions (ecoregion), California Regional Water Quality Control Boards (waterboard), administrative regions (adminregion), and groups (group).
Returned JSON is provided with:
| Name | Type | Description |
|---|---|---|
| regions | Object[] | List of individual regions of this region type |
| regions[].key | String|Number | Key for this region |
| regions[].name | String | Formatted name for this region |
| regionTypeKey | String | Region type key specified |
| regionTypeName | String | Formatted region type name |
Provides a list of all projects within the specified region.
Returned JSON is provided with:
| Name | Type | Description |
|---|---|---|
| projects | Object[] | List of projects in the specified region |
| projects[].projectid | Number | Project ID |
| projects[].projectname | Number | Project name |
| regionKey | String | Region key specified (group id, if found) |
| regionType | String | Region type key specified |
| regionTypeName | String | Formatted region type name |
You may search for projects within a group via a URI parameter to search by group name. This allows searches via proper strings (e.g. with whitespace). Special characters will be replaced with a character wildcard.
Returned JSON is provided with:
| Name | Type | Description |
|---|---|---|
| projects | Object[] | List of projects in the specified group |
| projects[].projectid | Number | Project ID |
| projects[].projectname | Number | Project name |
| regionKey | String | Region key specified (group id, if found) |
| regionType | String | Region type key specified (will be "group") |
| regionTypeName | String | Formatted region type name (group name, if found) |
Provides a list of all habitat projects.
Returned JSON is provided with:
| Name | Type | Description |
|---|---|---|
| projects | Object[] | List of projects in the specified region |
| projects[].projectid | Number | Project ID |
| projects[].projectname | Number | Project name |
| regionKey | String | Region key specified (which will default to "statewide" for a request for all habitat projects) |
| regionType | String | Region type key (which will default to "statewide" for a request for all habitat projects) |
| regionTypeName | String | Formatted region type name (which will default to "Statewide" for a request for all habitat projects) |
Provides details on the project specified by the Project ID.
Returned JSON is provided with:
| Name | Type | Description |
|---|---|---|
| alternateids | AlternateID[] | List of associated AlternateIDs for this project |
| contacts | Contact[] | List of associated Contacts for this project |
| counties | Object[] | List of counties this project overlaps |
| counties[].countyid | Number | ID of county |
| counties[].name | String | County name |
| groups | Group[] | List of associated Groups for this project |
| performancemeasures | PerformanceMeasure[] | List of associated PerformanceMeasures for this project |
| project | Object | Basic project information |
| project.abstract | String | Project abstract |
| project.adminregion | String | Administractive region of project |
| project.climateprojecttype | String | What type of climate adaptation project is this? |
| project.designcondition | String | How much sea level rise will the project be adaptable to in feet? |
| project.designlife | Number | How long project is designed to function in years? |
| project.ecoregion | String | Ecoregion of project |
| project.extremewaterlevel | String | What storm event is the project designed to accommodate? |
| project.floodingdescription | String | Does the project consider or address shallow groundwater flooding? (long value) |
| project.floodingname | String | Does the project consider or address shallow groundwater flooding? (short value) |
| project.impact_nomitigation_reqd | Boolean | If true, permittee-responsible mitigation is not required, and there is no mitigation project associated with this project. |
| project.mitigation_projectname | String | If project type is impact, then this is the name of the related mitigation project. |
| project.organization | String | Organization responsible for maintaining the project information |
| project.projectid | Number | Project ID |
| project.projectname | Number | Project name |
| project.projecttype | String | Project type |
| project.projecturl | String | Link of project page on EcoAtlas |
| project.region | String | Water board of project |
| project.totlestcost | Number | Total estimated cost |
| projectevents | Event[] | List of associated Events for this project |
| sites | Site[] | List of associated Sites for this project |
A wetland project may be tracked by a number of governmental and non-governmental entities. Typically, each entity assigns its own internal identification number or code to the project.
| Name | Type | Description |
|---|---|---|
| alternateid | String | Alternate ID |
| permittype | String | Type for ID |
People who have a relationship to the project.
| Name | Type | Description |
|---|---|---|
| firstname | String | First name |
| lastname | String | Last name |
| role | String | Role of contact |
Events are any kind of noteworthy event related to the project. The event date is flexible: it can be specific to the day, or just indicate a year, if more specific information is not available.
| Name | Type | Description |
|---|---|---|
| comments | String | Comments |
| eventdate | String | Date of event |
| eventtype | String | Type of event |
| projecteventid | Number | Event ID |
Groups are a way to associate related projects, e.g., projects related to a program, conservation plan, or different phases of a project.
| Name | Type | Description |
|---|---|---|
| groupid | Number | Group ID |
| name | String | Group name |
| organization | String | Organization attributed to group |
A project's performance measures typically describe the required environmental goals of the project, how to measure them, and what to do if they are not met. Target performance measures are defined at the beginning of a project, and actual performance measures track progress towards achieving these targets.
| Name | Type | Description |
|---|---|---|
| actual_datasource | String | Data source |
| actual_evaluationdate | String | Evaluation date |
| actual_evaluationphase | String | Evaluation phase |
| actual_measurestatus | String | Measure status |
| actual_totalactualvalue | Number | Value on evaluation |
| actual_unit | String | Units for value on evaluation |
| goal | String | Plan goal |
| plan | String | Plan name |
| target_begindate | String | Target start date |
| target_enddate | String | Target end date |
| target_totaltarget_value | Number | Targeted value |
| target_unit | String | Units of targeted value |
A project consists of one or more physical locations or sites. Most projects have just one site.
| Name | Type | Description |
|---|---|---|
| activities | SiteActivity[] | List of SiteActivities |
| site | Object | Basic site information |
| site.datum | String | Datum of site geometry |
| site.geom | String | WKT formatted geometry of site |
| site.latitude | Number | Latitude of site |
| site.longitude | Number | Longitude of site |
| site.name | String | Site name |
| site.projectboundary | Boolean | If true, the polygon associated with this site is for the entire project boundary. |
| site.status | String | Status of project site |
| site.siteid | Number | Site ID |
| site.subregion | String | Subregion name used to identify a planning region |
| siteevents | SiteEvent[] | List of SiteEvents |
Most activities represent physical changes in habitat that the project's proponents intend to carry out. The total project size should equal the sum of these changes (as recorded in the activity.amount field). Other activities are informational, such as Monitoring and Evaluation, Environmental Education/Outreach, and Demonstration.
| Name | Type | Description |
|---|---|---|
| activity | Object | Basic activity information |
| activity.activityid | Number | Activity ID |
| activity.activityphase | String | Phase or stage of the project |
| activity.activitystatus | String | Status of activity |
| activity.activitytype | String | Type of activity |
| activity.amount | Number | Size of the land area associated with the activity |
| activity.habitat | String | Habitat type |
| activity.includeacres | Boolean | If true, habitat or activity size acreage amounts are included in project area totals. Field is used to prevent double-counting of acres when there are multiple activities occurring on the same area. |
| activity.lowerelevation | Number | Lowest or most bayward elevation for the project activity in ft NAVD 88 |
| activity.slope | Number | Seaward facing slope of the project activity expressed as the ratio of horizontal distance to vertical rise (H:V). |
| activity.subhabitat | String | Subhabitat type |
| activity.unit | String | Units for above amount |
| activity.upperelevation | Number | Highest elevation for the project activity in ft NAVD 88 |
| funding | Object[] | List of funding provided by different entities for this activity |
| funding[].awarddate | String | Award date of funding |
| funding[].comments | String | Comments |
| funding[].fundingamount | Number | Funding amount in USD |
| funding[].fundingid | Number | Funding ID |
| funding[].grantcontractnum | String | Grant contract number |
| funding[].organization | String | Organization providing funding |
| funding[].program | String | Program associated with this funding |
| subactivity | Object[] | List of subactivities for this site activity |
| subactivity[].subactivityid | Number | Subactivity ID |
| subactivity[].subactivitytypename | String | Subactivity type |
Events are any kind of noteworthy event related to the site.
| Name | Type | Description |
|---|---|---|
| comments | String | Comments |
| eventdate | String | Date of event |
| eventtype | String | Type of event |
| siteeventid | Number | Event ID |