fRNAdb::API

イントロダクション

fRNAdb APIはWebブラウザやプログラムからfRNAdbを利用するためのWebサービスです。 fRNAdb APIはfRNAdbに対する検索機能、およびエントリデータの取得機能をRESTサービスにて提供します。 RESTサービスはHTTPプロトコルのGETメソッドでアクセスできます。

RESTサービス

miRNAで検索を行いたい場合、Webブラウザで以下のURLにアクセスします。

http://www.ncrna.org/frnadb/api/search/miRNA

語句、演算子、括弧を複数組合わせた複雑なクエリでの検索も可能です。
クエリ文法の詳細については、fRNAdb API クエリ文法をご覧下さい。

上記の検索リクエストに対するレスポンスは、以下のXMLドキュメントです。

<?xml version="1.0" encoding="UTF-8"?>
<result version="3.0" xmlns="http://www.ncrna.org/frnadb/api/XMLSchema/search">
  <query>
    <offset>0</offset>
    <limit>100</limit>
    <query_string>miRNA</query_string>
  </query>
  <count>70110</count>
  <entry_list next="http://www.ncrna.org/frnadb/api/search/miRNA/100,100">
    <entry id="FR000003" link="http://www.ncrna.org/frnadb/api/entry/FR000003" />
       :
    <entry id="FR000608" link="http://www.ncrna.org/frnadb/api/entry/FR000608" />
  </entry_list>
</result>

ヒット件数は<count>要素であり、70,110件です。
ヒットしたエントリのリストは<entry_list>要素です。ヒット件数が100件を超える場合、最初の100件だけが返されます。次の100件は以下のリクエストで得ることができます。

http://www.ncrna.org/frnadb/api/search/miRNA/100,100

レスポンスの詳細については、fRNAdb API レスポンスをご覧下さい。

RESTサービスでは、以下のAPIを提供しています。これらのAPIのレスポンスはXMLドキュメントです。

URL表現	処理内容	レスポンス
ベースURL/search/クエリ	ヒット件数とエントリリストを返す（エントリリストは最初の100件のみ）。	検索レスポンス
ベースURL/search/クエリ/offset,limit	ヒット件数とエントリリストを返す。エントリリストの範囲をoffsetとlimitで指定する。offset=100、limit=100の場合、101～200件目が返される。	検索レスポンス
ベースURL/search/クエリ/count	ヒット件数だけを返す。	検索レスポンス
ベースURL/entry/エントリID	指定エントリの全フィーチャを返す。	エントリレスポンス
ベースURL/entry/エントリID/フィーチャ	指定エントリの指定フィーチャを返す。	エントリレスポンス
ベースURL/entry/エントリID/map/info	指定エントリについてmapフィーチャーを持つゲノムの一覧を返す。	ゲノムレスポンス
ベースURL/entry/エントリID/map/ゲノム	指定エントリの指定ゲノムに対するmapフィーチャーを返す。	エントリレスポンス
ベースURL : http://www.ncrna.org/frnadb/api

フィーチャの詳細については、fRNAdb API エントリフィーチャをご覧下さい。

RESTサービスでは、一部のフィーチャについてXMLドキュメント以外のフォーマットでのレスポンスを要求することができます。
有効なURL表現は以下のとおりです。

URL表現	フォーマット
ベースURL/entry/エントリID/map/ゲノム.gff	Sanger Institute GFF
ベースURL/entry/エントリID/map/ゲノム.bed	UCSC BED
ベースURL/entry/エントリID/seq.fasta	NCBI FASTA

RESTサービスの例

リクエスト	URL例
検索	http://www.ncrna.org/frnadb/api/search/miRNA
検索（offset, limitを指定）	http://www.ncrna.org/frnadb/api/search/miRNA/101,100
検索（ヒット件数だけ要求）	http://www.ncrna.org/frnadb/api/search/miRNA/count
全フィーチャ取得	http://www.ncrna.org/frnadb/api/entry/FR000001
seqフィーチャ取得	http://www.ncrna.org/frnadb/api/entry/FR000001/seq
seqフィーチャ取得（FASTA）	http://www.ncrna.org/frnadb/api/entry/FR000001/seq.fasta
mapフィーチャを持つゲノム一覧取得	http://www.ncrna.org/frnadb/api/entry/FR000120/map/info
指定ゲノムに対するmapフィーチャー取得	http://www.ncrna.org/frnadb/api/entry/FR000120/map/hg18
指定ゲノムに対するmapフィーチャー取得（GFF）	http://www.ncrna.org/frnadb/api/entry/FR000120/map/hg18.gff
指定ゲノムに対するmapフィーチャー取得（BED）	http://www.ncrna.org/frnadb/api/entry/FR000120/map/hg18.bed

fRNAdb API クエリ文法

クエリはCQL-1.2に準拠します。
大文字、小文字の区別はしません。"mirna and trna"と"MIRNA AND TRNA"は同じクエリとみなします。

単語、フレーズ

"miRNA"を含むエントリを検索する。
http://www.ncrna.org/frnadb/api/search/miRNA

"mature miRNA"を含むエントリを検索する。
http://www.ncrna.org/frnadb/api/search/"mature miRNA"
論理演算子（and、or、not）

"snoRNA"、"U13"を両方含むエントリを検索する。
http://www.ncrna.org/frnadb/api/search/snoRNA and U13

"snoRNA"、"U13"のいずれかを含むエントリを検索する。
'http://www.ncrna.org/frnadb/api/search/snoRNA or U13

"snoRNA"を含み、かつ"U13"を含まないエントリを検索する。
http://www.ncrna.org/frnadb/api/search/snoRNA not U13

括弧によって評価順を変更できる。
http://www.ncrna.org/frnadb/api/search/(mature and miRNA) or (snoRNA and U13)
特定の識別子に対する検索

fRNAdbのGUIで定義されている識別子（Qualifier）を使用することができます。

識別子descriptionに"miRNA"を含むエントリを検索する。
http://www.ncrna.org/frnadb/api/search/desc=miRNA
関係演算子（all, any）

desc all "mature miRNA" と (desc=mature) and (desc=miRNA) は等しい。
（注意：　desc="mature miRNA"とは等しくありません）
http://www.ncrna.org/frnadb/api/search/desc all "mature miRNA"

desc any "mature miRNA" と (desc=mature) or (desc=miRNA) は等しい。
http://www.ncrna.org/frnadb/api/search/desc any "mature miRNA"

注意
参考文献に関する識別子ti（PubMed Title）とta(PubMed Title or Abstract)については、上記の等号は成り立ちません。
ti all "mature miRNA"は、タイトルに"mature"、"miRNA"の両方を含む参考文献だけを検索します。
あるエントリが2つの参考文献を持ち、その１つはタイトルに"mature"だけを含み、もう１つは"miRNA"だけを含む場合、(ti=mature) and (ti=miRNA)であれば検索されますが、ti all "mature miRNA"では検索されません。
塩基配列長

塩基配列長が21-23であるエントリを検索する。
http://www.ncrna.org/frnadb/api/search/len="21:23"

塩基配列長が21以下であるエントリを検索する。
http://www.ncrna.org/frnadb/api/search/len=":21"

塩基配列長が23以上であるエントリを検索する。
http://www.ncrna.org/frnadb/api/search/len="23:"

塩基配列長が21、25のいずれかであるエントリを検索する。
http://www.ncrna.org/frnadb/api/search/len any "21 25"
ソート（sortby）

昇順にソートする。
http://www.ncrna.org/frnadb/api/search/miRNA sortby len

降順にソートする。
http://www.ncrna.org/frnadb/api/search/miRNA sortby len%2Fsort.descending

fRNAdb API エントリフィーチャ

フィーチャ	内容
seq	塩基配列
acc	Genbankアクセション
org	生物種
so	SequenceOntology
pmid	PubMed文献情報
xid	エントリ自体のクロスリファレンス（RNAdb, Rfam等）
assoc	エントリに関連する遺伝子へのクロスリファレンス（OMIM, KEGG等）
map	ゲノムマッピング

fRNAdb API レスポンス

検索レスポンス

<?xml version="1.0" encoding="UTF-8"?>

<result version="3.0" xmlns="http://www.ncrna.org/frnadb/api/XMLSchema/search">

  <!-- 検索パラメータ -->
  <query>
    <offset>0</offset>
    <limit>100</limit>
    <query_string>miRNA</query_string>
  </query>

  <!-- ヒット件数 -->
  <count>70110</count>

  <!-- エントリリスト -->
  <entry_list next="http://www.ncrna.org/frnadb/api/search/miRNA/100,100">
    <entry id="FR000003" link="http://www.ncrna.org/frnadb/api/entry/FR000003"/>
   ：
    <entry id="FR000608" link="http://www.ncrna.org/frnadb/api/entry/FR000608"/>
  </entry_list>

</result>

エントリレスポンス

<?xml version="1.0" encoding="UTF-8"?>

<!-- 全フィーチャーを示すための架空のデータ -->

<result version="3.0" xmlns="http://www.ncrna.org/frnadb/XMLSchema/entry">

  <!-- 検索パラメータ -->
  <query>
    <feature>all</feature>
    <entry_num>1</entry_num>
    <entry_string>FR000000</entry_string>
  </query>

  <entry_list>

    <entry id="FR000000">

      <length>22</length>
      <sequence>CATGCCTTGAGTGTAGGACCGT</sequence>
      <description>mature micro RNA (miRNA) miR-532-5p or Piwi-interacting RNA (piRNA)</description>

      <ontology>
        <sequence_ontology id="SO:0001035" name="piRNA" version="2.3">
          <synonym>piwi-associated RNA</synonym>
        </sequence_ontology>
        <sequence_ontology id="SO:0000276" name="miRNA" version="2.3">
          <synonym>micro RNA</synonym>
          <synonym>microRNA</synonym>
          <synonym>micro</synonym>
        </sequence_ontology>
      </ontology>

      <organism>
        <ncbi_taxonomy  id="9913"  name="Bos taurus">
          <synonym>Bos bovis</synonym>
          <synonym>Bos primigenius taurus</synonym>
          <synonym>bovine</synonym>
          <synonym>cattle</synonym>
          <synonym>cow</synonym>
          <synonym>domestic cattle</synonym>
          <synonym>domestic cow</synonym>
        </ncbi_taxonomy> 
        <ncbi_taxonomy  id="9606"  name="Homo sapiens">
          <synonym>human</synonym>
          <synonym>man</synonym>
        </ncbi_taxonomy>
      </organism>

      <accession_list>
        <ncbi_genbank>DQ708952</ncbi_genbank>
        <ncbi_genbank>AF499825</ncbi_genbank>
      </accession_list>

      <reference>
        <ncbi_pubmed id="15199136">
          <title>Human box H/ACA pseudouridylation guide RNA machinery.</title>
          <authors>Kiss AM, Jady BE, Bertrand E, Kiss T</authors>
          <abstract>Pseudouridine, the most abundant modified nucleoside in RNA, is ... </abstract>
          <issue>Mol Cell Biol, 24(13):5797-807, 2004 Jul</issue>
          <cited_num>11</cited_num>
        </ncbi_pubmed>
      </reference>

      <!-- エントリ自体のCross Reference -->
      <cross_reference>
        <link to="RNAdb"    id="PIR217600"     version="2.0" />
        <link to="miRBase"  id="MIMAT0003848"  version="9.2" />
        <link to="miRBase"  id="MIMAT0002888"  version="9.2" />
        <link to="miRBase"  id="MIMAT0002889"  version="9.2" />
      </cross_reference>

      <!-- エントリに関連する遺伝子へのCross Reference -->
      <gene_association>
        <link to="OMIM"    id="156240" />
        <link to="OMIM"    id="606613" />
      </gene_association>

      <!-- snoRNA特有のCross Reference -->
      <snorna_feature>
        <host_gene>RPL7A (ribosomal protein L7A)</host_gene>
        <target_rna>18S rRNA A668</target_rna>
        <overlapping_gene  genome="hg18" type="UCSC Gene"    name="uc001ape.1">
          <genomebrowser_link>URI</genomebrowser_link>
        </overlapping_gene>
        <overlapping_gene  genome="hg18" type="UCSC Gene"    name="uc001apf.1">
          <genomebrowser_link>URI</genomebrowser_link>
        </overlapping_gene>
        <overlapping_gene  genome="hg18" type="RefSeq Gene"  name="BC062342">
          <genomebrowser_link>URI</genomebrowser_link>
        </overlapping_gene>
        <overlapping_gene  genome="dm3"  type="FlyBase Gene" name="CG15442-RA">
          <genomebrowser_link>URI</genomebrowser_link>
        </overlapping_gene>
      </snorna_feature>

      <!-- mature micro RNA特有のCross Reference -->
      <mirna_feature>
        <precursor_mirna>
          <link to="miRBase" id="MI0003205" version="9.2" />
          <link to="miRBase" id="MI0003206" version="9.2" />
          <link to="miRBase" id="MI0005061" version="9.2" />
          <link to="fRNAdb"  id="FR212689"  version="3.0" />
          <link to="fRNAdb"  id="FR336718"  version="3.0" />
          <link to="fRNAdb"  id="FR060646"  version="3.0" />
        </precursor_mirna>
      </mirna_feature>

      <!-- fRNAdb内の相補配列へのCross Reference -->
      <complementary_sequence>
        <link to="fRNAdb"   id="FR000000" version="3.0" />
      </complementary_sequence>

      <!-- fRNAdb内の類似配列へのCross Reference -->
      <highly_similar_sequence>
        <link to="fRNAdb"   id="FR000000" version="3.0" />
        <link to="fRNAdb"   id="FR000000" version="3.0" />
      </highly_similar_sequence>

      <!-- ゲノムマッピング情報 -->
      <map>
        <locus>
          <genome>hg17</genome>
          <cytoband>Xp11.23</cytoband>
          <chromosome>chrX</chromosome>
          <start>49470809</start>
          <end>49470830</end>
          <strand>+</strand>
          <exon_number>1</exon_number>
          <exon start="49470809" end="49470830" />
          <evidence>BLAT</evidence>
          <identity>100</identity>
          <genomebrowser_link>URI</genomebrowser_link>
        </locus>
      </map>

      <!-- 発現情報（GEO） -->
      <expression>
        <tissue description="S2 cells, AGO2 IP" read_number="2" evidence="varidated">
          <ncbi_taxonomy  id="7227"  name="Drosophila melanogaster">
            <synonym>Drosophila melangaster</synonym>
            <synonym>fruit fly</synonym>
          </ncbi_taxonomy>
          <ncbi_pubmed id="16778019">
            <title>Characterization of the piRNA complex from rat testes.</title>
            <authors>Lau NC, Seto AG, Kim J, Kuramochi-Miyagawa S, Nakano T, Bartel DP, Kingston RE</authors>
            <abstract>Small noncoding RNAs regulate processes essential ... </abstract>
            <issue>Science, 313(5785):363-7, 2006 Jul, Epub 2006 Jun</issue>
            <cited_num>25</cited_num>
          </ncbi_pubmed>
          <link to="NCBI_GEO"      id="GSM280089" />
          <method>Illumina-Solexa</method>
          <experiment description="small RNAs"
                      authors="Czech B, Malone CD, Zhou R, Stark A, ... Hannon GJ, Brennecke J"
                      date="2008-04-30">
            <ncbi_taxonomy  id="7227"  name="Drosophila melanogaster">
              <synonym>Drosophila melangaster</synonym>
              <synonym>fruit fly</synonym>
            </ncbi_taxonomy>
            <link to="NCBI_GEO"      id="GSE11086" />
          </experiment>
        </tissue>
      </expression>

    </entry>

  </entry_list>

</result>

ゲノムレスポンス

<?xml version="1.0" encoding="UTF-8"?>

<result version="3.0" xmlns="http://www.ncrna.org/frnadb/XMLSchema/genome">

  <entry_list>
    <entry id="FR000000">
      <genome_list link="http://www.ncrna.org/frnadb/FR000000/map">
        <genome name="hg17" link="http://www.ncrna.org/frnadb/FR000000/map/hg17" />
        <genome name="hg18" link="http://www.ncrna.org/frnadb/FR000000/map/hg18" />
      </genome_list>
    </entry>
  </entry_list>

</result>