Loading
PDBj
メニューPDBj@FacebookPDBj@TwitterPDBj@YouTubewwPDB FoundationwwPDB
RCSB PDBPDBeBMRBAdv. SearchSearch help

RESTインタフェース

このページの他言語版もあります: English
新しいWebインターフェースでアクセスできるサービスの多くは、RESTインターフェースで動作します。 このRESTインターフェースは、ユーザーに一般公開されています。 また、使い方の例も公開しています。
PDBjのRESTサービスは、/rest/というURLで公開されています。

検索 API

URLhttps://pdbj.org/rest/newweb/search/omni
入力
  • query: 検索クエリ
  • fields: 検索対象フィールド(任意、指定しない場合は全フィールドが検索対象)
返り値フィールド(カテゴリー)ごとにマッチしたリストをJSONエンコードで返す。
備考すべてのPDBjデータベースの簡易検索(IDとタイトルのみ等)を行います。

URLhttps://pdbj.org/rest/newweb/search/pdb
入力
  • query: 検索クエリ
  • limit: 取得結果数の上限(任意)
  • offset: 結果取得開始位置(自然数、任意、limitと組み合わせて利用)
  • sortBy: 並べ替え方法 (1: ヒットスコア, 2: 文献出版日の古い順、 3: 文献出版日の新しい順、 4: 最終更新日の古い順、5: 最終更新日の新しい順) (任意, 規定値は 1)
  • lang: 言語の指定(文字列、任意、指定がない場合の既定値は「lang=en」(英語)。ja(日本語)を指定した場合に限り、日本語を英語に翻訳したキーワードも含めて検索される。)
  • noro: 実際の結果を返すのではなく、結果数だけを返す
  • query: 全フィールドが検索対象(任意)
  • pdbid: PDBIDフィールドを検索(任意)
  • title: タイトル(文字列、任意、タイトルフィールドが検索対象)
  • c_authors: 参照文献著者名(文字列、任意、参照文献著者名フィールドが検索対象)
  • c_title: 参照文献タイトル(文字列、任意、参照文献タイトルフィールドが検索対象)
  • c_name: 参照文献雑誌名(文字列、任意、参照文献雑誌名フィールドが検索対象)
  • c_volume: 参照文献雑誌巻号(任意、参照文献雑誌巻号が検索対象)
  • compound_info: 化合物(文字列、任意、compoundフィールドを検索)
  • other_db_select: 検索対象を指定した外部データベースに限定する。指定は任意で指定できる値は以下のいずれか一つ。「ec number」、「embl」、「emdb」、「gb」、「go」、「pir」、「pubmed id」、「doi」、「uniprot」、「pfam」
  • other_db_field: 外部データベースID(文字列、任意)。何らかの文字列を指定する場合はother_db_selectとセットで指定する。この項目に何も指定せず、other_db_selectのみを指定した場合、指定データベースで値がNULLではないもの全てが結果として返される。
  • ligand: リガンド(文字列、任意、ligandフィールドが検索対象)
  • source: 由来生物種(文字列、任意、由来生物種フィールドが検索対象)
  • host_species: 宿主生物種(文字列、任意、宿主生物種フィールドが検索対象)
  • rdate_before: 公開日の範囲指定を行う時の開始日(任意)
  • rdate_after: 公開日の範囲指定を行う時の終了日(任意)
  • ddate_before: 登録日の範囲指定を行う時の開始日(任意)
  • ddate_after: 登録日の範囲指定を行う時の終了日(任意)
  • mdate_before: 最終更新日の範囲指定を行う時の開始日(任意)
  • mdate_after: 最終更新日の範囲指定を行う時の終了日(任意)
  • c_year: 参照文献の発行年を指定(西暦を示す4桁の数値、任意)
  • chain_type_0: D体ポリペプチドを含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_1: L体ポリペプチドを含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_2: ポリデオキシリボヌクレオチド(DNA)を含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_3: ポリリボヌクレオチド(RNA)を含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_4: 多糖(D体)を含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_5: 多糖(L体)を含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_6: DNA/RNA 複合体を含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_7: 環状疑似ペプチドを含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_type_8: その他を含むかどうかを指定。1なら含む、2なら含まない(1か2、任意、指定がない場合は含んでも含まなくてよい)
  • chain_number_min: 鎖数の最小値を指定(自然数、任意)
  • chain_number_max: 鎖数の最大値を指定(自然数、任意)
  • chain_length_min: 鎖の長さ(残基数・塩基数)の最小値を指定(自然数、任意)
  • chain_length_max: 鎖の長さ(残基数・塩基数)の最大値を指定(自然数、任意)
  • res_min: 分解能の最小値 (Å)
  • res_max: 分解能の最大値 (Å)
  • method: 実験手法(1〜5の自然数、任意、指定がない場合の既定値は1、各値の意味は以下の通り。1: X線回折(xray diffraction)、2: 中性子回折(neutron diffraction)、3: 線維回折(fiber diffraction)、4: 電子線結晶解析(electron crystallography)、5: 電子顕微鏡(electron microscopy)、6: 溶液NMR(solution nmr)、7: 固体NMR(solid-state nmr)、8: 溶液散乱(solution scattering)、9: 粉末回折(powder diffraction)、10: 赤外分光法(infrared spectroscopy)、11: 電子常磁性共鳴(epr)、12: 蛍光転移(fluorescence transfer)、13: 理論モデル(theoretical model)、14: 複数手法(hybrid)、15: 廃止された理論モデル(theoretical model (obsolete))
返り値json形式で書かれたメタデータ(結果数など)と結果一覧(後者はnoro=0の指定がある場合のみ)
備考PDBj MineのPDB検索に相当します。

URLhttps://pdbj.org/rest/newweb/search/cc
入力
  • query: 検索クエリ(文字列、必須)
  • limit: 取得結果数の上限(自然数、任意)
  • offset: 結果取得開始位置(自然数、任意、limitと組み合わせて利用)
  • sortBy: 並べ替え方法 (1: ヒットスコア、 2: comp_id の昇順、 3: comp_id の降順、 4: 公開日の古い順、 5: 公開日の新しい順、 6: 最終更新日の古い順、 7: 最終更新日の新しい順 (任意、規定値は 1)
  • lang: 言語の指定(文字列、任意、指定がない場合の既定値は「lang=en」(英語)。ja(日本語)を指定した場合に限り、日本語を英語に翻訳したキーワードも含めて検索される。)
  • noro: 実際の結果を返すのではなく、結果数だけを返す
  • code: comp_idで検索(任意)
  • mol_name: 分子名で検索 (chem_comp.name)(任意)
  • formula: 組成式で検索 (chem_comp.formula)(任意)
  • smiles: SMILESで検索(任意)
  • inchi: InChIで検索earches by inchi (optional)
  • format: 返り値の書式を指定(指定できる値はjson, csv, tsv, jsonpのいずれか一つ)
返り値JSON形式で書かれたメタデータ(結果数など)と結果一覧(後者はnoro=0の指定がある場合のみ)
備考PDBj Mineリガンドの簡易検索

URLhttps://pdbj.org/rest/newweb/search/prd
入力
  • query: 検索クエリ
  • limit: 取得結果数の上限(任意)
  • offset: 結果取得開始位置(自然数、任意、limitと組み合わせて利用)
  • sortBy: 並べ替え方法 (1: ヒットスコア, 2: comp_idの昇順、 3: comp_idの降順、 4: 公開日の古い順、5: 公開日の新しい順)、6: 最終更新日の古い順、7: 最終更新日の新しい順) (任意, 規定値は 1)
  • lang: 言語の指定(文字列、任意、指定がない場合の既定値は「lang=en」(英語)。ja(日本語)を指定した場合に限り、日本語を英語に翻訳したキーワードも含めて検索される。)
  • noro: 実際の結果を返すのではなく、結果数だけを返す
  • format: 返り値の書式を指定(指定できる値はjson, csv, tsv, jsonpのいずれか一つ)
返り値json形式で書かれたメタデータ(結果数など)と結果一覧(後者はnoro=0の指定がある場合のみ)
備考PDBj Mine BIRDの簡易検索

URLhttps://pdbj.org/rest/newweb/search/status
入力
  • limit: 取得結果数の上限(任意)
  • offset: 結果取得開始位置(自然数、任意、limitと組み合わせて利用)
  • sortBy: 並べ替え方法 (1: ヒットスコア, 2: PDB IDの昇順、 3: PDB IDの降順、 4: 登録日の古い順、5: 登録日の新しい順)、6: ステータスコードの昇順、7: ステータスコードの降順) (任意, 規定値は 1)
  • lang: 言語の指定(文字列、任意、指定がない場合の既定値は「lang=en」(英語)。ja(日本語)を指定した場合に限り、日本語を英語に翻訳したキーワードも含めて検索される。)
  • noro: 実際の結果を返すのではなく、結果数だけを返す
  • keyword/query: 検索キーワード・クエリ(文字列、任意、全フィールドが検索対象)
  • pdbid: PDBID(1-9の数字+英数字3文字、任意、PDBIDフィールドが検索対象)
  • authors: 著者名(文字列、任意、著者名フィールドが検索対象)
  • title: タイトル(文字列、任意、タイトルフィールドが検索対象)
  • status_code: ステータスコード(任意)
  • author_release_sequence: 著者が公開した配列(文字列、任意、指定がない場合の既定値はなし=配列は検索に考慮しない)
  • exclude_WDRN: 登録が取り下げられた(=ステータスが「WDRN」である)エントリーを除外する(指定可能値は0と1、任意、0を指定すると除外せず1を指定すると除外する。指定がない場合の既定値は0)
  • ddate_after: 登録日の範囲指定を行う時の終了日(任意)
  • ddate_before: 登録日の範囲指定を行う時の開始日(任意)
返り値JSON形式で書かれたメタデータ(結果数など)と結果一覧(後者はnoro=0の指定がある場合のみ)
備考未公開エントリーの検索(ステータス検索)
URLhttps://pdbj.org/rest/newweb/search/blog
入力
  • query: 検索クエリ(文字列、必須)
  • limit: 取得結果数の上限(自然数、任意)
  • offset: 結果取得開始位置(自然数、任意、limitと組み合わせて利用)
  • sortBy: 並べ替え方法 (1: ヒットスコア, 2: 文献出版日の古い順、 3: 文献出版日の新しい順、 4: 最終更新日の古い順、5: 最終更新日の新しい順) (任意, 規定値は 1)
  • lang: 言語の指定(文字列、任意、指定がない場合の既定値は「lang=en」(英語)。ja(日本語)を指定した場合に限り、日本語を英語に翻訳したキーワードも含めて検索される。)
  • noro: 実際の結果を返すのではなく、結果数だけを返す
  • CID: 記事カテゴリID(CID、自然数、必須)
返り値JSONjson形式で記した結果。メタデータと内容のリストを含む。
備考検索条件に一致する記事を取得する。

URLhttps://pdbj.org/rest/newweb/search/sql
入力
  • q: SQLクエリ
  • limit: 取得結果数の上限(自然数、任意)
  • offset: 結果取得開始位置(自然数、任意、limitと組み合わせて利用)
  • 返り値指定した書式による検索結果
    備考Mine 2 関係データベース(RDB)に対してSQL検索を行います。

    Mineエントリー API

    URLhttps://pdbj.org/rest/newweb/fetch/file
    入力
    • id: エントリーID、生物学的単位構造のファイルの場合、xxxx.yという形式で指定してください(xxxx:PDBID、y:生物学的単位のID)
    • type: ファイル形式
    • version: ファイルのバージョン (規定値は0)
    返り値指定されたエントリーIDに対する情報をファイルで返す
    備考指定されたエントリーIDに対するファイルをダウンロードする。
    URLhttps://pdbj.org/rest/newweb/fetch/file-loc
    入力
    • id: エントリーID、生物学的単位構造のファイルの場合、xxxx.yという形式で指定してください(xxxx:PDBID、y:生物学的単位のID)
    • type: ファイル形式
    • version: ファイルのバージョン (規定値は0)
    返り値指定されたエントリーIDに対するファイルの場所を返す
    備考指定されたエントリーIDに対するPDBjデータ領域のファイルの場所を返す
    URLhttps://pdbj.org/rest/newweb/fetch/batch-download-prep
    入力
    • ids: カンマ区切りのエントリーIDs
    • formats: カンマ区切りのファイル形式一覧
    返り値要求オブジェクトのダウンロード(分割)
    備考/rest/newweb/batch-downloadに渡すダウンロード要求オブジェクトの配列を返す (JSONフォーマット)

    URLhttps://pdbj.org/rest/newweb/fetch/batch-download
    入力
    • payload: /rest/newweb/batch-download-prepで生成された要求オブジェクトをダウンロード
    返り値要求オブジェクトのダウンロード(分割)
    備考/rest/newweb/batch-downloadに渡すダウンロード要求オブジェクトの配列を返す (JSONフォーマット)

    URLhttps://pdbj.org/rest/newweb/fetch/batch-data-fetch
    入力
    • ids: カンマ区切りのエントリーID一覧
    • schema: 選択対象のスキーマ (例: pdb, cc)
    • items: 取得するカンマ区切りのデータ項目 (テーブル.列 / カテゴリ.データ名)
    • format: 結果のデータフォーマット (mmjson, mmcif, json-column, json-row)
    返り値指定したフォーマットによる指定エントリーに対するデータ項目
    備考PDBから任意のメタデータを抽出 (旧CIFクエリサービスの後継)

    URLhttps://pdbj.org/rest/newweb/fetch/rdb
    入力
    • entryId: カンマ区切りのエントリーIDs
    • schemaName: 選択するスキーマ (例: pdb, cc)
    • tables: 取得するテーブル又はカテゴリ一覧(カンマ区切り)
    返り値入力エントリーIDに対して要求したテーブル又はカテゴリの一覧をmmjsonフォーマットで取得
    備考関係データベースからテーブル又はカテゴリをmmjsonフォーマットで抽出

    その他のAPI

    URLhttps://pdbj.org/rest/newweb/edmap
    入力
    • pdbid: 処理するエントリーのPDBID
    • mode: マップ種別モード (2fo-fc/fo-fc)
    • xyz: どの原子周りでマップを作成するかを指定したJSONフォーマットのxyz座標一覧
    • border: 原子回りで作成するマップサイズ (規定値は10)
    返り値ccp4フォーマットのEDMap
    備考あるエントリーに対するローカルEDMapを作成する

    URLhttps://pdbj.org/rest/newweb/seqnavi
    入力
    • pdbid: 処理するエントリーのPDBID
    • chainid: 処理するエントリーの非対称単位の鎖明
    • type: 鎖種別 (prot/nucl)
    • seq: 配列入力
    返り値jsonフォーマットによる結果
    備考指定したPDB ID又は鎖名又はカスタム配列に対してBLASTを実行する

    URLhttps://pdbj.org/rest/newweb/seqnavi/cluster
    入力
    • entryIds: エントリー IDs (pdbidと鎖名との対)
    • dcut: 類似配列のクラスタリングに対するカットオフ値
    返り値jsonフォーマットによる結果
    備考エントリーのクラスタリング

    URLhttps://pdbj.org/rest/newweb/fetch/promode_tgz
    入力
    • id: promodeエントリーID
    返り値tgz圧縮ファイルでのpromode elasticデータ
    備考promode elasticデータファイルを取得

    URLhttps://pdbj.org/rest/newweb/rss/news
    入力
    • lang: 処理する言語
    返り値RSSフォーマットによる結果
    備考RSSフォーマットでの新しい記事一覧

    URLhttps://pdbj.org/rest/newweb/cms/list
    入力
    • recursive: 全てのサブディレクトリを対象とする
    • limit: 取得結果数の上限
    • offset: 結果取得開始位置
    • year: 記事公開日の年
    • sort: 作成日又は更新日による並べ替え
    返り値JSONフォーマットによる結果
    備考JSONフォーマットでの記事とファイル一覧


    作成日: 2015-03-31 (最終更新日: more than 1 year ago)2021-07-02

    217705

    件を2024-03-27に公開中

    PDB statisticsPDBj update infoContact PDBjnumon