エンドポイント
API は用途別に catalog / compute / delivery の 3 グループに分かれます。課金単位はグループで異なります。
catalog API
catalog API は、文書やニュースを発見し、次に何を取得すべきか判断するための API です。0 billable units です。
| Endpoint | 用途 |
|---|---|
GET /v1/issuers/search | 企業名・証券コードから issuer を検索 |
GET /v1/documents | 文書一覧を取得 |
GET /v1/documents/{document_id} | 文書詳細を取得 |
GET /v1/documents/{document_id}/toc | 目次とセクション情報を取得 |
GET /v1/documents/{document_id}/page-images | 取得可能なページ画像を列挙 |
GET /v1/news | news 一覧を取得 |
GET /v1/news/{news_id} | news 詳細を取得 |
GET /v1/issuers/{security_code}/activity は後続マイルストーンで提供予定です。documents-first launch 中の issuer monitoring は GET /v1/documents と GET /v1/news の組み合わせで行います。
0 billable units は無制限を意味しません。すべての API は認証、レート制限、quota の対象です。plan ごとの具体的な利用上限は Pricing を参照してください。
compute / delivery API
compute / delivery API は、検索や本文・画像取得のための API です。成功した 2xx レスポンスだけが compute units として計上されます。
| Endpoint | 用途 |
|---|---|
POST /v1/search/documents | 文書本文を意味検索 |
POST /v1/search/news | news を検索 |
GET /v1/documents/{document_id}/content | 文書本文または指定セクションを取得 |
GET /v1/documents/{document_id}/pages/{page_number}/image | ページ画像を取得 |
ページ画像は全ページにあるとは限りません。image_available=true の文書でも、まず catalog API の GET /v1/documents/{document_id}/page-images で取得可能ページを確認してください。
documents と news の横断検索 API は後続マイルストーンで提供予定です。現行 v1 では /search/documents と /search/news を用途別に呼び分けてください。
endpoint / request / response schema の詳細は API Reference を参照してください。API Reference は momonga-search-api の OpenAPI から生成しています。