GET/v1/investors/searchプラン · Free

投資家検索

投資家名またはEDINETコードで検索します。

クエリパラメータ · 2

任意のフィルターと修飾子。URLエンコードした ?key=value で渡します。

qstring必須

検索クエリ

limitinteger任意

1ページあたりの件数

default 20

リクエストヘッダー · 1

認証ヘッダー。

Authorizationstring必須

本番用のAPIキー。次の形式で渡します: Bearer ax_live_…

返り値 · 200

標準の { data, meta } エンベロープ。 data は InvestorSearchResult 型の配列です。

エンベロープ

dataInvestorSearchResult[]

結果オブジェクトの配列。

metaMeta

ページネーションとリクエストメタデータ。request_iddata_as_ofontology_version を含みます。

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

InvestorSearchResult

edinet_codestring | null
name_jpstring | null
name_enstring | null
positionsinteger | null

エラー

標準のHTTPステータスコードに加え、{ error: { code, message } } エンベロープ内で型付きの error.code を返します。

すべてのエンドポイントは共通の型付きエラーエンベロープ({ error: { code, message } })を返します。 全コードの一覧はエラーリファレンスを参照してください。