クエリパラメータ · 5
任意のフィルターと修飾子。URLエンコードした ?key=value で渡します。
検索クエリ
セクションキーでフィルター。mda(経営者分析), risk_factors(リスク情報), business_overview(事業の内容), strategy(経営方針), sustainability(サステナビリティ), research_and_development(研究開発), dividend_policy(配当政策), governance(ガバナンス), company_history(沿革), employees(従業員), critical_contracts(重要な契約), capital_expenditures(設備投資), accounting_policy(会計方針), segment_info(セグメント情報), financial_instruments(金融商品)
決算年度でフィルター
1ページあたりの件数
スキップする件数(cursor指定時は無視)
リクエストヘッダー · 1
認証ヘッダー。
本番用のAPIキー。次の形式で渡します: Bearer ax_live_…
返り値 · 200
標準の { data, meta } エンベロープ。 data は TranslationSearchResult 型の配列です。
エンベロープ
結果オブジェクトの配列。
ページネーションとリクエストメタデータ。request_id、data_as_of、ontology_version を含みます。
TranslationSearchResult
一致が見つかったセクション名。
一致するキーワードがハイライトされたテキストスニペット。
一致した企業のEDINET提出者コード。
会社名(日本語)。
一致した書類の決算年度。
一致した書類のEDINET書類ID。
PostgreSQL ts_rankの関連度スコア。高いほど関連性が高い。
エラー
標準のHTTPステータスコードに加え、{ error: { code, message } } エンベロープ内で型付きの error.code を返します。
すべてのエンドポイントは共通の型付きエラーエンベロープ({ error: { code, message } })を返します。 全コードの一覧はエラーリファレンスを参照してください。