Application Programming Interface (API)

• 1. API supported by the National Diet Library Great East Japan Earthquake Archive (HINAGIKU)
  • 1.1. Search API
  • 1.2. Harvest API
  • 1.3. HINAGIKU API
• 2. Data available via API
  • 2.1. Available data
  • 2.2. Metadata formats
  • 2.3. Metadata updates
  • 2.4. List of Data Providers and Available Metadata

1. API supported by the National Diet Library Great East Japan Earthquake Archive (HINAGIKU)

HINAGIKU supports both search API and harvest API. Metadata from all data providers in the "List of Data Providers and Available Metadata" can be acquired by either API.
Please read the "About API use application" page before using API. If you wish to use API from a service other than HINAGIKU, please see the "List of API" page on the National Diet Library website.

1.1. Search API

You can search HINAGIKU metadata using the search API. The available search conditions will vary depending on the API protocol used.
The search API is compliant with SRU and OpenSearch.
You can make search windows by incorporating the search API.

1.2. Harvest API

You can download HINAGIKU metadata using the harvest API, which is made available by OAI-PMH.
Metadata downloaded from HINAGIKU can be imported to other systems.
※The harvest API uses some cache functions, which could affect response, depending on conditions and timing of the request.

1.3. HINAGIKU API

The details of each API are as follows.

Type of API	Protocol	Input format	Output format	Access URL	Note
Search API	SRU	URL	XML(RDF)	https://kn.ndl.go.jp/api/sru	You can search in the same way as simple search and advanced search of HINAGIKU.
Search API	OpenSearch	URL	XML(RSS)	https://kn.ndl.go.jp/api/opensearch
Harvest API	OAI-PMH	URL	XML	https://kn.ndl.go.jp/api/oaipmh

For details of each protocol, please see each link page of "Protocol".

2. Data available via API

2.1. Available data

Only metadata is available.

2.2. Metadata formats

Metadata of HINAGIKU is compliant with "The National Diet Library Great East Japan Earthquake Archive Metadata Schema", which is based on The National Diet Library Dublin Core Metadata Description (DC-NDL).
Format of data returned by each protocol is also based on "The National Diet Library Great East Japan Earthquake Archive Metadata Schema".

2.3. Metadata updates

Metadata is not updated in real time. Rather, batch processing is carried out daily.
If you search or harvest metadata by API around midnight Japan Standard Time, the metadata you receive might not be the latest version.

2.4. List of Data Providers and Available Metadata

For either search API or harvest API, you can narrow the range of search objects by specifying a Repository ID for the following Data Providers.
For the outlines of each Repository, please see the page "The list of searchable databases and others".

As of August 18th, 2023 (Repository ID order)

Repository ID	Data Provider	Provider of metadata	Condition for secondary use of metadata（○ means "application is not needed"）
			For non-commercial use	For commercial use
R200000002	National Diet Library postgres	NDL	○	○
R200000004	National Diet Library Periodical Index	NDL	○	○
R200000007	Current Awareness Portal (National Diet Library)	NDL	○	Application is needed
R200100039	National Diet Library Digital Collections	NDL	○	Application is needed
R200200001	Other Providers (Persons)	NDL	○	○
R200200004	Japan Atomic Energy Agency's Library Catalog	Other institution	○	○
R200200006	National Diet Library Web Archiving Project	NDL	○	○
R200200015	NAIIC (National Diet of Japan, Fukushima Nuclear Accident Independent Investigation Commission)	NDL	○	○
R200200017	Japan Platform (JPF)	NDL	○	○
R200200018	Jupiter Telecommunications (J:COM)	NDL	○	○
R200200020	Tokyo Bookbinding Club	NDL	○	○
R200200022	Tokyo Electric Power Company Holdings	NDL	○	○
R200200024	Japan NGO Center for International Cooperation (JANIC)	NDL	○	○
R200200027	Other Providers (Organizations)	NDL	○	○
R200200028	Japan Foundation	NDL	○	○
R200200029	Higashi Nihon Gekisai Fukko Shinbun	NDL	○	○
R200200030	AERO ASAHI CORPORATION	NDL	○	○
R200200031	Remembering 3.11 (Tohoku Gakuin)	Other institution	○	○
R200200033	NWEC Women and Disaster Archive (National Women's Education Center of Japan)	Other institution	○	○
R200200039	Shinchi Town Library (Fukushima Prefecture)	NDL	○	○
R200200040	ICT Project for Preserving Community Ties "Telling the Story of the Great East Japan Earthquake" (Higashimatsushima Library)	NDL	○	○
R200200041	National Diet Library	NDL	○	○
R200200043	Aomori Disaster Archive	Other institution	○	○
R200200044	The record of the earthquakes on the history of municipality (Saitama Prefectural Kumagaya Library)	Other institution	○	○
R200200045	The Simplest Explanation of The National Diet of Japan Fukushima Nuclear Accident Independent Investigation Commission Report	Other institution	○	○
R200200046	Japan Society of Civil Engineers Great East Japan Earthquake Archive	Other institution	○	○
R200200047	Nuclear Regulation Authority	NDL	○	○
R200200048	Nippon Foundation	NDL	○	○
R200200049	Center for Remembering 3.11 (sendai mediatheque)	Other institution	○	○
R200200050	Japanese Government Internet TV	NDL	○	○
R200200051	Disaster Management Library Catalog	Other institution	○	○
R200200052	Geospatial Information Authority of Japan (GSI)	NDL	○	○
R200200053	Nagaoka Post-Disaster Reconstruction Collection	Other institution	○	○
R200200058	Ministry of the Environment, Government of Japan	NDL	○	○
R200200059	Ministry of Defense	NDL	○	○
R200200060	Fukushima Nuclear Accident Archive (Japan Atomic Energy Agency)	Other institution	○	○
R200200061	Great East Japan Earthquake Archive Miyagi	Other institution	○	○
R200200062	Koriyama Disaster Archive	Other institution	○	○
R200200064	Disaster Information Laboratory, National Research Institute for Earth Science and Disaster Resilience	NDL	○	○
R200200067	Urayasu Disaster Archive	Other institution	○	○
R200200068	Disaster Information Laboratory, National Research Institute for Earth Science and Disaster Resilience Catalog	Other institution	○	○
R200200069	Tohkai Shimpo	NDL	○	○
R200200070	Post-disaster Images Acquisition (Corporate Social responsibility) (PASCO CORPORATION)	NDL	○	○
R200200072	yu keikaku jimusyo	NDL	○	○
R200200073	Otsuchi Town Waterworks Office	NDL	○	○
R200200074	Takata Driving School	NDL	○	○
R200200076	Architect Partnership in Morioka	NDL	○	○
R200200077	Ministry of Health, Labour and Welfare	NDL	○	○
R200200078	Nuclear Regulation Authority (Archived Information on the Fukushima Daiichi Accident)	NDL	○	○
R200200079	Kokusai Kogyo	NDL	○	○
R200200080	Prime minister's office of Japan	NDL	○	○
R200200081	Mie Disaster Mitigation Archive	Other institution	○	○
R200200082	Syasin Kikaku	NDL	○	○
R200200083	Historical archive section in Nagaoka City Central Library	NDL	○	○
R200200084	Kyodo News	NDL	○	○
R200200086	Iwate Earthquake Tsunami Archive: Hope	Other institution	○	○
R200200087	Ajinomoto	NDL	○	○
R200200088	Miyagi Prefectural Library	NDL	○	○
R200200089	Iwate Prefectural Library	NDL	○	○
R200200095	Digital Archives of Kumamoto Disasters	Other institution	○	○
R200200096	Cabinet Office	NDL	○	○
R200200097	Repository of Natural Disaster Documents of IWATE (Iwate University)	Other institution	○	○
R200200098	Reconstruction Agency	NDL	○	○
R200200099	Iwate Future Organization	NDL	○	○
R200200100	311 Iwate NPO Flyer Archive (IWATE Fukkou Collaboration Center)	Other institution	○	○
R200200102	National Diet Library collection of flyers and other materials related to earthquake disasters	NDL	○	○
R200200103	Online database of materials on earthquake disaster (Tohoku University Library)	Other institution	○	○
R200200104	Citizen's group to think about reconstruction of Ishinomaki City	NDL	○	○
R200200105	Database of Disaster Pictures (INSTITUTE OF SCIENTIFIC APPROACHES FOR FIRE AND DISASTER)	Other institution	○	○
R200200107	Red Cross Nuclear Disaster Resource Center Digital Archives (Transferred)	Other institution	○	×
R200200108	Disaster Reduction and Human Renovation Institution	Other institution	○	○
R200200112	Project "What Can We Do Now?"	NDL	○	○
R200200118	2014 Kamishiro Fault Earthquake Archive	Other institution	○	○