CiNii - API(1) of CiNii - About OpenSearch for Articles

About　OpenSearch

With the new CiNii, it is possible to interact with CiNii using OpenSearch*. Here, we will explain the basics of searching with OpenSearch.

* For more information about OpenSearch, please refer to the following website.
http://www.opensearch.org/Specifications/OpenSearch/1.1/Draft_4

A Search for Articles with your browser’s search bar.

A-1. Search for Articles with the search bar on Firefox

Click on the Firefox search bar and select "CiNii OpenSearch".
Enter keyword(s) in the search bar and the browser will take you to the article search results page.

A-2. Search for Articles with the search bar on Safari (Macintosh).

To customize the search bar, a plug-in must be installed. Here, we will use a plug-in called AcidSearch.
Install AcidSearch and then open the settings window and select “New Channel”.
Add CiNii.
Click on the Safari search bar and select CiNii.
Enter keyword(s) in the search bar and the browser will take you to the article search results page.

A-3. Search for Articles with the search bar on Internet Explorer

Click on the Internet Explorer(more than 7) search bar and select "CiNii OpenSearch".
Enter keyword(s) in the search bar and the browser will take you to the article search results page.

B Search for Articles using an OpenSearch query

It is possible to search CiNii using an OpenSearch query in the same manner as using the search feature of the CiNii website.

Example query：
http://ci.nii.ac.jp/opensearch/search?q=%E5%AE%89%E9%81%94&count=20&start=1&lang=ja&title=library&author=&affiliation=&journal=&issn=&volume=&issue=&
page=&publisher=&references=&year_from=&year_to=&range=&sortorder=&format=rss
Example response (RSS feed)：

query specification
http://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).
1	q	This parameter is necessary to encode the URL.
2	count	Specifies the number of search results per page (optional)
2	count	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)
3	lang	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)
4	start	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)
5	format	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	issn	Searches by ISSN.
9	publisher	Searches by publisher name. It is necessary to encode the URL.
10	affiliation	Searches by author affiliation. It is necessary to encode the URL.
11	journal	Searches by journal name. It is necessary to encode the URL.
12	volume	Searches by volume.
13	issue	Searches by issue.
14	page	Searches by page.
15	references	Searches by references. It is necessary to encode the URL.
16	year_from	Searches by year of publication (From).
17	year_to	Searches by year of publication (To).
18	range	Specifies the search target option.
18	range	The default is 0. 0:all / 1: full text document on CiNii / 2: full text document on CiNii or link to partner service
19	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
		citing works: descending order 7

RSS1.0 Response Format Specification

No.	Tag						required	content	Remarks
No.	First level	Second level	Third level	Fourth level	Fifth level	Attribute	required	content	Remarks
1	xml						required	Declare as XML document	<?xml version="1.0" encoding="utf-8" ?>
2	rdf:RDF						Required	Document route element	Describe the returned language with the xml:lang attribute. Describe attributes other than xml:lang with the following character strings.
									<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		Requested URI	Encode the query in the URI and input using the format “parameter=value”. Connect using “&”.
4			title					Title	Has connected the query to “CiNii OpenSearch-”.
4			title					Title	<title>CiNii OpenSearch ? Interaction + 大向</title>
5			link					Requested URI
6			dc:date					Date when search was executed	W3CDTF format
7			opensearch:totalResults					Total search results
8			opensearch:startIndex					Start number	Indicates from which record number among the search results the data is being described.
9			opensearch:itemsPerPage					Results per page	Indicates how many search results are included in the response.
10			items
11				rdf:Seq
12					rdf:li	rdf:resource		PermaLink	Lists the permalink to the article(s) included in the response.
13		item				rdf:about		Article information	Describe the PermaLink with rdf:about.
13		item				rdf:about		Article information	<item rdf:about="http://ci.nii.ac.jp/naid/1234567890">
14			title					Article name
15			link					PermaLink
16			rdfs:seeAlso			rdf:resource		Url to rdf	<rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/naid/1234567890/rdf" />
17			dc:creator					Author name	Forms a list when there is more than one.
18			dc:publisher					Publisher
19			prism:publicationName					Publication name
20			prism:issn					ISSN
21			prism:volume					Volume
22			prism:number					Issue
23			prism:startingPage					Start page
24			prism:endingPage					End page
25			prism:pageRange					Pages
26			prism:publicationDate					Date of publication	W3CDTF format
27			description					Abstract	The displayed content is assumed to be that which is displayed when the user is not logged in.
28			dc:date					Date of publication	The same content as prism:publicationDate

Atom1.0 Response Format Specification

No.	Tag name					Required	Content	Remarks
No.	First level	Second level	Third level	Fourth level	Attribute	Required	Content	Remarks
1	xml					required	Declare as XML document	<?xml version="1.0"encoding="UTF-8" ?>
2	feed					Required	Document routeelement	Describe the returned language with the xml:lang attribute. Describe attributes other than xml:lang with the following character strings.
								<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					Feed title	Has connected the query to “CiNii OpenSearch-”.
3		title					Feed title	<title>CiNii OpenSearch ? Interaction + 大向</title>
4		link			href=		Query URL	Encodes the query in the URI and input using the format “parameter=value”. Connect using “&”.
5		id					Query URI	Same as the link element.
6		updated					Date when searcwas executed	W3CDTF format
7		opensearch:totalResults					Total search results
8		opensearch:startIndex					Start number	Indicates from which record number among the search results the data is being described.
9		opensearch:itemsPerPage					Results per page	Indicates how many search results are included in the response.
10		entry					Container that stores information on article search results
11			title				Article name
12			link		href		Bibliography URI	Displays the PermaLink.
13			link		href		RDF’s URI	Displays RDF’s URI.
14			id				Bibliography URI	Displays the PermaLink.
15			author					Forms a list when there is more than one.
16				name			Author name
17			dc:publisher				Publisher
18			prism:publicationName				Publication name
19			prism:issn				ISSN
20			prism:volume				Volume
21			prism:number				Issue
22			prism:startingPage				Start page
23			prism:endingPage				End page
24			prism:pagePange				Pages
25			prism:publicationDate				Date of publication	W3CDTF format
26			content				Article abstract	The displayed content is assumed to be that which is displayed when the user is not logged in.
26			content				Article abstract	<content type="text"></content>
27			updated				Date of publication	The same content as prism:publicationDate

C OpenSearch RSS and Atom Feed.

You can check for updates to the results of an OpenSearch keyword search if you bookmark the results page in an RSS or Atom feeder.

Example: bookmark in the Firefox RSS reader.

An OpenSearch RSS or Atom feeder search results page is displayed.
Push the “subscribe” button.
On the “add live bookmark” window, push the “add” button.
The search results RSS feed is bookmarked on the bookmarks toolbar.