Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

National Archives and Records Administration Online Availability API

Information about record online availability

National Archives and Records Administration Online Availability API is one of 16 APIs that National Archives and Records Administration publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Online Availability. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 0.2.0.

Requests are made against a single base URL, https://catalog.archives.gov/api/v2/.

4 operations 4 paths 1 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.2.0
Base URL
https://catalog.archives.gov/api/v2/
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Online Availability 4

Information about record online availability

GET
/online-availability
Get all online availability information.
5 params → 200400422
GET
/online-availability/naId/{naId}
Get all online availability information for a record with the given naId.
1 param → 200400422
PUT
/online-availability/update
Update or insert online availability information given a record's naId.
body → 200400422
DELETE
/online-availability/delete
Completely remove online availability information for a given record naId.
1 param → 200500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is onlineAvailabilityBody (3 properties). Each schema is shown below with its type and property counts.

onlineAvailabilityBody
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

national-archives-and-records-administration-online-availability-api-openapi.yml Raw ↑

Other APIs National Archives and Records Administration publishes across the network.

National Archives and Records Administration Accounts API
National Archives and Records Administration Announcements API
National Archives and Records Administration Comments API
National Archives and Records Administration Contributions API
National Archives and Records Administration Extracted Text API
National Archives and Records Administration Justifications API
National Archives and Records Administration Metadata API
National Archives and Records Administration Other Extracted Text API
National Archives and Records Administration Partner API
National Archives and Records Administration Records API
National Archives and Records Administration Statistics API
National Archives and Records Administration Tags API