CiNii Articles - Metadata and API - CiNii Articles OpenSearch for Articles

Contents

 

Query Specification

CiNii Articles OpenSearch for Articles query is as follows.
https://ci.nii.ac.jp/opensearch/search?(parameter=value)& (parameter=value)&…&(parameter=value)

Each parameter that comprises the query is as follows.

No. parameter content
1 q Specifies keyword to be searched (necessary when items 6-17 are not specified).
This parameter is necessary to encode the URL.
2 count Specifies the number of search results per page (optional)
The default is 20. When a value under 0 or exceeding 200 is specified, or when no value is specified, it will be considered as the default value. (The maximum number of search results that can be displayed on a single page is 200.)
3 lang Specifies the language the search results are displayed in (optional)
The default is ja. Specify Japanese (ja) or English (en). When a character string other than ja or en is specified, or when no character string is specified, it will be considered as the default value.
4 start Start number for the acquired search result list (optional)
The default is 0. When a value under 0 or exceeding the number of results is specified, it will be considered as the default value.
5 format Specifies the format of the response (optional)
The default is xhtml (regular search results page). rss/atom can be specified. The rss/atom format is described later.
6 title Searches by article name. It is necessary to encode the URL.
7 author Searches by author name. It is necessary to encode the URL.
8 authorid Searches by author id (NRID).
9 issn Searches by ISSN.
10 publisher Searches by publisher name. It is necessary to encode the URL.
11 affiliation Searches by author affiliation. It is necessary to encode the URL.
12 journal Searches by journal name. It is necessary to encode the URL.
13 volume Searches by volume.
14 issue Searches by issue.
15 page Searches by page.
16 references Searches by references. It is necessary to encode the URL.
17 year_from Searches by year of publication (From).
18 year_to Searches by year of publication (To).
19 range Specifies the search target option.
The default is 0. 0:all / 1: full text document on CiNii / 2: full text document on CiNii or link to partner service
20 sortorder Specifies the sorting condition. The default is 1.
Year of publication: descending order 1 / ascending order 2
article name: descending order 3 / ascending order 4
journal name: descending order 5 / ascending order 6
no. of cited by: descending order 7
21 appid Required
 

Response Specification

You can choose the response format with query from RSS, Atom, JSON-LD and HTML.

"Access-Control-Allow-Origin" is required on http header for response, and it is available to use asynchronous communication between cross domains.

 

RSS1.0 Response Format Specification

No. Tag name Required Content Remarks
First level Second level Third level Fourth level Fifth level Attribute
1 xml           Required Declare as XML document <?xml version="1.0" encoding="utf-8" ?>
2 rdf:RDF           Required Document route element Language code of the response will appear at xml:lang attribute. Other attributes are as follows.
  <rdf:RDF
xmlns xmlns="http://purl.org/rss/1.0/"
xmlns:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xxmlns:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:prism xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/"
xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xml:lang xml:lang="ja">
3   channel       rdf:about Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;" ,and "appid" will be removed from parameter.
4     title       Required Title Concatenation with query to "CiNii OpenSearch-" .
Example:
<title>CiNii OpenSearch - インタラクション+大向</title>
5     description       Required Title Same as the above
6     link       Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;", and "appid" will be removed from parameter.
7     dc:date       Required Date when search was executed W3CDTF format
8     opensearch:totalResults       Required Total search results  
9     opensearch:startIndex         Start number Indicates from which record number among the search results the data is being described.
10     opensearch:itemsPerPage         Results per page Indicates how many search results are included in the response.
11     items            
12       rdf:Seq          
13         rdf:li rdf:resource   URI of Bibliography Details Page Indicates how many search results are included in the response. Repeated at most until the number of opensearch:itemsPerPage.
14   item       rdf:about   Article information Repeated at most until the number of opensearch:itemsPerPage. The permalink is described in rdf:about.
<item rdf:about="https://ci.nii.ac.jp/naid/1234567890">
15     title         Title  
16     link         URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
<link>https://ci.nii.ac.jp/naid/1234567890</link>
17     rdfs:seeAlso     rdf:resource   URI of Bibliography RDF Indicates the URI of Bibliography RDF (except parameter of appid)
<rdfs:seeAlso rdf:resource="https://ci.nii.ac.jp/naid/1234567890/rdf" />
18     dc:creator         Author name Repeated if there are multiple items.
19     dc:publisher         Publisher  
20     prism:publicationName         Publication name  
21     prism:issn         ISSN  
22     prism:volume         Volume  
23     prism:number         Number  
24     prism:startingPage         Start page  
25     prism:endingPage         End page  
26     prism:pageRange         Pages  
27     prism:publicationDate         Date of publication W3CDTF format
28     description         Abstract The displayed content is assumed to be that which is displayed when the user is not logged in.
29     dc:date         Date of publication The same as prism:publicationDate
 

Atom1.0 Response Format Specification

No. Tag name Required Content Remarks
First level Second level Third level Fourth level Attribute
1 xml         Required Declare as XML document <?xml version="1.0"encoding="UTF-8" ?>
2 feed         Required Document route element Language code of the response will appear at xml:lang attribute. Other attributes are as follows.
  <feed
xmlns xmlns="http://www.w3.org/2005/Atom"
xmlns:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:prism xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/"
xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xml:lang xml:lang="ja">
3   title       Required Feed title Concatenation with query to "CiNii OpenSearch-".
<title>CiNii OpenSearch - インタラクション+大向</title>
4   link     href Required Query URL URL of Equivalent search with HTML. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;" and "appid" will be removed from parameter.
5   link     rel Required Relation with reference at linked page Fixed: "self"
6         type Required MIME type of reference at linked page Fixed: "application/atom+xml"
7         href Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;" and "appid" will be removed from parameter.
8   id       Required Requested URI Same as the link element.
9   updated       Required Date when search was executed W3CDTF format
10   opensearch:totalResults       Required Total search results  
11   opensearch:startIndex         Start number Indicates from which record number among the search results the data is being described.
12   opensearch:itemsPerPage         Results per page Indicates how many search results are included in the response.
13   entry         Container that stores information on articles search results. Repeated at most until the number of opensearch:itemsPerPage.
14     title       Title  
15     link   href   URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
<link href="https://ci.nii.ac.jp/naid/1234567890"/>
16     link   rel   Relation with reference at linked page Fixed: "alternate"
17         type   MIME type of reference at linked page Fixed: "application/rdf+xml"
18         href   URI of Bibliography RDF Indicates the URI of Bibliography RDF (except parameter of appid)
href="https://ci.nii.ac.jp/naid/1234567890.rdf"
19     id       URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
<link href="https://ci.nii.ac.jp/naid/1234567890"/>
20     author       Description of Author Repeated if there are multiple items.
21       name     Author name  
22     dc:publisher       Publisher  
23     prism:publicationName       Publication name  
24     prism:issn       ISSN  
25     prism:volume       Volume  
26     prism:number       Number  
27     prism:startingPage       Start page  
28     prism:endingPage       End page  
29     prism:pagePange       Pages  
30     prism:publicationDate       Date of publication W3CDTF format
31     content       Article abstract The displayed content is assumed to be that which is displayed when the user is not logged in.<content type="text">[抄録の内容]</content>
32     updated       Date of publication The same as prism:publicationDate
 

JSON-LD Response Format Specification

No. Tag Name Type Required Contents Remarks
First level Second level Third level Fourth level Fifth level
1 @context         Object Required Document route element "@context": {
"dc": "http://purl.org/dc/elements/1.1/",
"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
"opensearch": "http://a9.com/-/spec/opensearch/1.1/",
"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
"prism": "http://prismstandard.org/namespaces/basic/2.0/",
"@vocab": "http://purl.org/rss/1.0/"
},
2   @vocab         Required   http://purl.org/rss/1.0/
3   dc         Required   http://purl.org/dc/elements/1.1/
4   rdf         Required   http://www.w3.org/1999/02/22-rdf-syntax-ns#
5   opensearch         Required   http://a9.com/-/spec/opensearch/1.1/
6   rdfs         Required   http://www.w3.org/2000/01/rdf-schema#
7   prism         Required   http://prismstandard.org/namespaces/basic/2.0/
8 @id           Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. "appid" will be removed from parameter.
9 @graph         Array Required   Element count of array is 1
10   @id         Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. "appid" will be removed from parameter.
11   @type         Required   Fixed: "channel"
12   title         Required Title Concatenation with query to "CiNii OpenSearch"
Example:
"title":"CiNii OpenSearch - 検索エンジン 順位",
13   description         Required Title Same as the above
14   link       Object Required    
15     @id       Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. "appid" will be removed from parameter.
16   dc:date         Required Date when search was executed W3CDTF format
17   opensearch:totalResults         Required Total search results  
18   opensearch:startIndex           Start number Indicates from which record number among the search results the data is being described.
19   opensearch:itemsPerPage           Results per page Indicates how many search results are included in the response.
20   items       Array      
21     @id         URI of the Bibliography Details Page Permalink to articles in the response.
22     @type           Fixed: "item"
23     title         Title  
24     link     Object      
25       @id       URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
"link": {@id:"https://ci.nii.ac.jp/naid/1234567890"},
26     rdfs:seeAlso     Object      
27       @id       URI of Bibliography JSON-LD Indicates the URI of Bibliography JSON-LD (except parameter of appid)
"rdfs:seeAlso":{@id:"https://ci.nii.ac.jp/naid/1234567890.json"},
28     dc:creator     Array   Author name Repeated if there are multiple items
29     dc:publisher         Publisher  
30     prism:publicationName         Publication name  
31     prism:issn         ISSN  
32     prism:volume         Volume  
33     prism:number         Number  
34     prism:startingPage         Start page  
35     prism:endingPage         End page  
36     prism:pageRange         Page range  
37     prism:publicationDate         Date of publication W3CDTF format
38     description         Abstract A displayed content is assumed to be that which is displayed when an user is not logged in.
39     dc:date         Date of publication The same as prism:publicationDate
 

Revision History

You can check revision history of CiNii Articles JSON-LD API for Articles later April, 2013.

March 13, 2015

JSON-LD response format has been partly changed. The details are as follows;

  • Type of "items" tag has changed from "Object" to "Array".
  • "rdf:Seq" and "rdf:li" tags have not been used.
  • CiNii Web APIs by JSON-LD has become official version.

Nobember 4, 2014

  • Query paramater "authorid" has added to Query Specification.

October 29, 2013

  • JSON-LD Format (json) has added to output format for Query Specification.
  • JSON-LD (Beta version) has added to Response Format Specification.
  • It has been available to use asynchronous communication between cross domains.