KAKEN – Metadata / API

 

Query Specifications

The KAKEN’s OpenSearch query takes the following format:
https://kaken.nii.ac.jp/opensearch/?(parameter=value)&(parameter=value)&…&(parameter=value)

For the parameter, please use the Application ID obtained by registering at CiNii - Metadata and API - API User Registration and enter it in the following format: appid=xxxxxxxx.

For the details of other operational parameters, please refer to Queries’ Constitutive Parameters.

 

Obtaining Related Documents

You can download the XML definition file obtainable via API and XMLs of various master data used in KAKEN from the following site:

KAKEN Master Data

KAKEN XML Definition

 

Queries’ Constitutive Parameters

The details of parameters that constitute the queries are as follows:

No.  Parameter Contents
1 kw The parameter that specifies free words (mandatory when items Nos.6-26 are not specified)
The value has to be URL encoded.
2 rw The parameter that specifies the number of the search results per page (optional)
The default is 20. 20, 50, 100, 200 and 500 can be selected.
3 lang The parameter that specifies the language of the search results (optional)
The default is ‘ja’. Either Japanese (ja) or English (en) can be selected. The default setting will be adopted when a string other than ‘ja’ or ‘en’ is used or when it is not specified.
4 st The starting number of the List of Search Results to be obtained (optional)
The default is ‘1’. The default setting will be adopted when the number less than ‘0’ is selected. Error when values over the maximum number of search items (200,000 items) or non-numeric values are entered.
5 format The parameter that specifies the response format (optional)
xhtml, xml, or json (under construction) can be selected. The default is xhtml (the standard display for the List of Search). The default setting will be adopted when other strings are used or when it is not specified.
6 qa It enables you to search by Research Project Title. The value has to be URL encoded.
7 qb It enables you to search by Project Number
8 c6 It enables you to search by Project Type. Multiple values can be selected.
project: Research Project
area: Innovative Area
organizer: Organizer
wrapup: Wrap-up
planned: Planned
publicly: Public
international: International
9 qc It enables you to search by Research Category. The value has to be URL encoded.
10 c7 It enables you to search by Allocation Types. Multiple values can be selected.
hojokin: Single-year Grant
kikin: Multi-year Fund
ichibu_kikin: Partial Multi-year Fund
11 qd It enables you to search by Review Section/Research Field. The value has to be URL encoded.
12 qe It enables you to search by Research Institutions. The value has to be URL encoded.
13 s1 It enables you to search by Project Period (From). Error when non-numeric values are entered.
14 s2 It enables you to search by Project Period (To). Error when non-numeric values are entered. Error when From > To.
15 o1 The parameter that specifies the search conditions for funding agencies. The default is ‘1’. The default setting will be adopted when a code other than the values below is specified.
1: Research Start Year
2: Research End Year
3: Including a part of the research period
4: Including the entire period of a research project
16 s3 It enables you to search by Total Costs (Overall). ‘1’ will be adopted when a code other than the values below is specified.
1:< 1,000,000
2:1,000,000 ~ 5,000,000
3:5,000,000 ~ 10,000,000
4:10,000,000 ~ 50,000,000
5:50,000,000 ~ 100,000,000
6:100,000,000 ~ 500,000,000
7:> 500,000,000
17 c1 It enables you to search by Project Status. Multiple values can be selected.
adopted: Adopted
granted: Granted
ceased: Ceased
suspended: Suspended
project_closed: Completed
declined: Declined
discontinued: Discontinued
18 qf It enables you to search by Keywords. The value has to be URL encoded.
19 qn It enables you to search by Research Summary. The value has to be URL encoded. *This can be used only when the language is English (en).
20 qg It enables you to search by Researcher Name. The value has to be URL encoded.
21 qh It enables you to search by Researcher’s Affiliation. The value has to be URL encoded.
22 qm It enables you to search by Researcher Number. The value has to be URL encoded.
23 c2 It enables you to search by Researcher's Role. Multiple values can be selected.
principal_investigator: Principal Investigator
area_organizer: Area Organizer
co_investigator_buntan: Co-Investigator(Kenkyū-buntansha)
co_investigator_renkei: Co-Investigator(Renkei-kenkyūsha)
research_collaborator: Research Collaborator
research_fellow: Research Fellow
host_researcher: Host Researcher
foreign_research_fellow: Foreign Research Fellow
principal_investigator_support: Principal Investigator(Support)
co_investigator_buntan_support: Co-Investigator(Kenkyū-buntansha)(Support)
24 c3 It enables you to search by Report / Assessment Type. Multiple values can be selected.
jiseki_hokoku: Annual Research Report
jiko_hyoka_hokoku: Self-evaluation Report
kenkyu_sinchoku_hyoka: Research Progress Assessment
kenkyu_seika_hokoku_gaiyo: Final Research Report Summary
chukan_hyoka_hokoku: Interim Assessment Report
jigo_hyoka_hokoku: Ex-post Assessment Reportb
jishi_jokyo_hokoku_kikin: Research-status Report
kenkyu_seika_hokoku: Final Research Report
saitaku_shoken: Comments on Screening Results
saitaku_gaiyo: Abstract
kenkyu_shinchoku_hyoka_gaiyo: Abstract (Research Progress Assessment)
kenkyu_shinchoku_hyoka_genchi_chosa: Research Progress Assessment (Comments on Site Visits)
kenkyu_shinchoku_hyoka_keka: Research Progress Assessment (Result)
kenkyu_shinchoku_hyoka_kensho: Research Progress Assessment (Verification Result)
tsuiseki_hyoka_shoken: Comments (Follow-up Assessment)
tsuiseki_hyoka_jiko_hyoka: Self-evaluation (Follow-up Assessment)
tsuiseki_hyoka_kenkyu_gaiyo: Abstract (Follow-up Assessment)
chukan_hyoka_shoken: Interim Assessment (Comments)
jigo_hyoka_shoken: Ex-post Assessment (Comments)
kenkyu_seika_hapyo_hokoku: Research Products Report
25 s4 It enables you to search by Assessment Rating. The value has to be URL encoded.
A+
A
A-
B
C
26 s5 The parameter that specifies the search conditions for Assessment Rating Type. This parameter can only be used with the parameter 's4' .
remark_chukan: Interim Assessment Comments
remark_jigo: Ex-post Assessment Comments
assessment: Result
inspection: Verification Result
27 qi It enables you to search by Publications. The value has to be URL encoded.
28 c4 It enables you to search by ‘in Japan / Overseas’. Multiple values can be selected.
false: in Japan
true: Overseas
29 qj It enables you to search by Identifier (ISSN, ISBN, etc)
30 c5 It enables you to search by Research Output Type. Multiple values can be selected.
journal_article: Journal Article
presentation: Presentation
symposium: Funded Workshop
book: Book
press: Press Release
note: Remarks
patent: Patent (Industrial Property Rights)
publication: Publications
31 qk It enables you to search by Publication Year of research products (From). Error when non-numeric values are entered.
32 ql It enables you to search by Publication Year of research products (To). Error when non-numeric values are entered. Error when From > To.
33 od The parameter that specifies the sort conditions. The default is ‘2’.
1: Relevance
2: Research Start Year (Newest)
3: Research Start Year (Oldest)
4: Total Budget Amount: Dsc
5: Total Budget Amount: Asc
 

Revision History

November 21, 2018

  • Content of query paramater "qc" has changed.
  • Content of query paramater "qd" has changed.
  • Query paramater which specifies the sorting condition has changed from "sortorder" to "od".