API for OPUS


Purpose

OPUS API distributes limited attributes from OPUS shared solutions.

PID Service

Query Parameter

Description

Pid *

A 6-character alphanumeric ID associated with a survey mark. One or more PIDs may be queried using a comma delimiter.

Example:

Single PID:

https://geodesy.noaa.gov/api/opus/pid?pid=BBBH86

Multiple PIDs:

https://geodesy.noaa.gov/api/opus/pid?pid=BBBH86,BBCH69

Radial search

Query Parameter

Description

lat *

Latitude in decimal degrees or degrees-minutes-seconds (DMS) format; if DMS format is used, prefix the value with a hemisphere designator (N or S) and use DDMMSS.ssssss format; decimal seconds are optional.

Example: decimal degrees: 40.75 DMS format N404500.0

lon *

Longitude in decimal degrees or degrees-minutes-seconds (DMS) format; if DMS format is used, prefix the value with a hemisphere designator (E or W) and use DDDMMSS.ssssss format; decimal seconds are optional. For decimal degrees, negative west longitude convention is used.

Example: decimal degrees: -80.75 DMS format W0804500.0

radius *
Search radius, a numeric value
units
Units of radius; defaults to MILE, if not specified. Other units available for use are METER, KILOMETER, FOOT
Note: A maximum limit of 500 is set for the number of sets returned. Adjust the radius accordingly so that a complete set is returned for the search.

Example:

https://geodesy.noaa.gov/api/opus/radial?lat=40.0&lon=-80.0&radius=5.25

Using METER as units:

https://geodesy.noaa.gov/api/opus/radial?lat=40.0&lon=-80.0&radius=400&units=METER


Bounding Box Search

Query Parameter

Description

minlat *

Minimum latitude of the bounding box in decimal degrees or degrees-minutes-seconds(DMS) format; if DMS format is used, prefix the value with a hemisphere designator (N or S) and use DDDMMSS.ssssss format; decimal seconds are optional.

Example: decimal degrees: 40.75 DMS format N404500.0

maxlat *

Maximum latitude of the bounding box in decimal degrees or degrees-minutes-seconds(DMS) format; if DMS format is used, prefix the value with a hemisphere designator (N or S) and use DDMMSS.ssssss format; decimal seconds are optional.

Example: decimal degrees: 40.75 DMS format N404500.0; maxlat > minlat

minlon *
Minimum longitude of the bounding box in decimal degrees or degrees-minutes-seconds(DMS) format; if DMS format is used, prefix the value with a hemisphere designator (E or W) and use DDDMMSS.ssssss format; decimal seconds are optional. For decimal degrees, negative west longitude convention is used.

Example: decimal degrees: -80.75 DMS format W0804500.0

maxlon *
Maximum longitude in decimal degrees or degrees-minutes-seconds(DMS) format; if DMS format is used, prefix the value with a hemisphere designator (E or W) and use DDDMMSS.ssssss format; decimal seconds are optional. For decimal degrees, negative west longitude convention is used.

Example: decimal degrees: -80.75 DMS format W0804500.0; maxlon > minlon


Note: A maximum limit of 500 is set for the number of sets returned. Adjust the bounds accordingly so that a complete set is returned for the search.

Example:

http://geodesy.noaa.gov/api/opus/bounds?minlat=40.0&minlon=-80.0&maxlat=40.01&maxlon=-79.9

Sample Response
{
"pid": "BBCH69",
"ts": "11115183347",
"designation": "HOWARD 2010",
"stCounty": "PA,Centre County",
"refFrame": "NAD_83(2011)",
"epoch": "2010.0000",
"lat": "41.0199440361",
"latDms": "N410111.79853",
"latP2p": "0.006",
"lon": "-77.6537193167",
"lonDms": "W0773913.38954",
"lonP2p": "0.001",
"ellHt": "169.764",
"ellHtP2p": "0.005",
"datum": "NAVD88 (Computed using GEOID12B)",
"orthoHt": "203.029",
"orthoHtP2p": "0.015",
"observed": "2010-11-23T13:24:00Z",
"agency": "US Army Corps of Engineers",
"monumentType": "Disk",
"stamping": "HOWARD 2010",
"stability": " Monument will probably hold position well",
"setting": " Light structures (other than listed below)",
"condition": "G"
}

Nearest Publishable Point Service

This service returns PID, designation, lat-longs, and distance in meters of a nearest publishable point from a given lat-long. Lat-longs may be entered in decimal degrees, DMS, or mixed format.

Example: (Location of PID BBBH32)

https://geodesy.noaa.gov/api/opus/nearestpp?lat=N390809.67434 &lon=W0771038.63406
Sample Response
{
"pid": "JV2187",
"lat": "39.1366666667",
"latDms": "N390812.00000",
"lon": "-77.1775000000",
"lonDms": "W0771039.00000",
"designation": "WASHINGTON GROVE BORR",
"distance": "72.256"
}

Country/City Locator Service

This service returns a country, state, and city for a given lat-long. Lat-longs may be entered in decimal degrees, DMS, or mixed format.

Example:

https://geodesy.noaa.gov/api/opus/gc?lat=43.6352&lon=-79.3832
Sample Response
{
"country": "Canada",
"state": "Ontario",
"city": "Lake Ontario"
}

Metadata

The following URL provides metadata for various parameters used in the JSON response: https://geodesy.noaa.gov/api/opus/meta

* Required Field