{"openapi":"3.1.0","info":{"title":"vivldatabase API","version":"1.0.0","summary":"株価以外のオルタナティブデータを一括取得。AIトレード・クオンツ研究向け公式イベントAPI。","description":"株価以外の公式オルタナティブデータとEDINET開示を、JSON / CSVで取得できる研究用APIです。\n大量取得は /v1/alternative-data を利用します。過去の初回市場到達時刻を保証するPITデータではありません。\nすべてのデータに出典の書類ID(`doc_id`)と原典URLが付き、開示書類まで遡れます。\n\n## 認証\n購入時に発行されるAPIキーを `Authorization: Bearer <APIキー>` ヘッダーで送ってください(`x-api-key` ヘッダーも可)。\n購入は /pricing から。全プラン7日間無料です。\n\n## レスポンス形式\n成功時は `{ \"data\": ..., \"meta\": { \"source\", \"fetched_at\", ... } }`、\n失敗時は `{ \"error\": { \"code\", \"message\" } }` です。**分岐は `error.code` で行ってください**(`message` の文言は変わることがあります)。\n\n## 料金とレート制限\n| プラン | 月額(税込) | 月間リクエスト上限 | レート制限 |\n| --- | --- | --- | --- |\n| Pro | ¥1,480 | 10,000 | 60回/分 |\n| Ultra | ¥4,980 | 100,000 | 300回/分 |\n| Mega | ¥14,800 | 1,000,000 | 600回/分 |\n\n分間の上限を超えると `429 rate_limited`、月間の上限を超えると `429 plan_limit` が返ります(どちらも `Retry-After` 付き)。\n月間の上限は毎月1日0時(日本時間)にリセットされ、REST と MCP の呼び出しは合算されます。\n成功時のレスポンスヘッダー `x-quota-limit` / `x-quota-remaining` / `x-quota-reset` で残り回数が分かります。\n\n## MCP\n同じAPIキーで MCPサーバー(`POST /mcp`、Streamable HTTP)も使えます。Claude などのAIアシスタントから、\nこのAPIの各エンドポイントをツールとして直接呼び出せます。","termsOfService":"https://vivlica.vivlica.workers.dev/legal/terms","contact":{"url":"https://vivlica.vivlica.workers.dev/legal/tokushoho"}},"servers":[{"url":"https://vivlica.vivlica.workers.dev"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"tags":[{"name":"alternative-data","description":"株価以外の機械可読な公式イベント・一括CSV/JSON"},{"name":"filings","description":"提出書類(その日に何が開示されたか)"},{"name":"financials","description":"有価証券報告書の数値"},{"name":"companies","description":"収録銘柄の指標"},{"name":"entities","description":"再配布可能な法人情報"}],"paths":{"/v1/alternative-data":{"get":{"tags":["alternative-data"],"operationId":"getAlternativeData","summary":"オルタナティブデータを統一JSON・CSVで一括取得","description":"年次報告書索引、官公需入札公告、海外政策イベントの出典付きメタデータ。\n株価、正確な初回市場到達日時、確定していない企業名寄せ、PITバックテスト適格性は含まれません。\n1リクエスト最大1,000件。続きは meta.next_offset を offset に指定します。","parameters":[{"name":"dataset","in":"query","description":"データ種別","schema":{"type":"string","enum":["all","annual_reports","tender_notices","policy_events"],"default":"all"}},{"name":"code","in":"query","description":"証券コードによる絞り込み。会社との確定関連を持つ年次報告書のみ返す","schema":{"type":"string","example":"7203"}},{"name":"from","in":"query","description":"イベント日(YYYY-MM-DD)の下限","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"イベント日(YYYY-MM-DD)の上限","schema":{"type":"string","format":"date"}},{"name":"observed_before","in":"query","description":"当サービスの取得日上限。完全なPIT保証ではない","schema":{"type":"string","format":"date"}},{"name":"source","in":"query","description":"情報源ID（EDINET・KKJ・UK_HANSARD・UK_BILLSなど）。完全一致","schema":{"type":"string","example":"KKJ"}},{"name":"topic","in":"query","description":"トピックの部分一致。80文字まで","schema":{"type":"string","maxLength":80,"example":"水素"}},{"name":"linked_only","in":"query","description":"企業への確定紐付けが存在するイベントのみ。公告・政策イベントは通常除外されます","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000,"default":200}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"maximum":50000,"default":0}},{"name":"format","in":"query","schema":{"type":"string","enum":["json","csv"],"default":"json"}}],"responses":{"200":{"description":"ソース・日付・企業照合状態を付けた機械可読な公式イベント","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AlternativeEvent"}},"meta":{"type":"object","description":"total / next_offset / coverage / point_in_time_ready=false を含む"}}}},"text/csv":{"schema":{"type":"string","description":"UTF-8 BOM CSV。データ行はJSONと同じ12フィールド"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/filings":{"get":{"tags":["filings"],"operationId":"listFilings","summary":"指定日の提出書類を全件取得","description":"その日にEDINETへ提出された書類を、提出時刻の昇順で全件返します。","parameters":[{"name":"date","in":"query","description":"提出日(日本時間、YYYY-MM-DD)。省略時は今日。過去10年分まで","schema":{"type":"string","format":"date","example":"2026-10-01"}},{"name":"category","in":"query","description":"書類の分類で絞り込む","schema":{"type":"string","enum":["tob","largeHolding","extraordinary","buyback","offering","annual","quarterly","other"]}},{"name":"code","in":"query","description":"証券コードで絞り込む(提出者・大量保有の対象会社・TOBの対象会社のいずれかが一致)","schema":{"type":"string","example":"7203"}}],"responses":{"200":{"description":"提出書類の一覧","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Filing"}},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"},"finalized":{"type":"boolean","description":"過去日(確定済み)なら true。当日分は提出のたびに増える"}}}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/large-holdings":{"get":{"tags":["filings"],"operationId":"listLargeHoldings","summary":"大量保有報告書・変更報告書","description":"「誰が」「どの銘柄を」5%超保有した/保有割合を変えたかの報告です。対象会社は `issuer` に入ります。","parameters":[{"name":"date","in":"query","description":"提出日(日本時間、YYYY-MM-DD)。省略時は今日。過去10年分まで","schema":{"type":"string","format":"date","example":"2026-10-01"}},{"name":"code","in":"query","description":"証券コードで絞り込む(対象会社・提出者のいずれかが一致)","schema":{"type":"string","example":"7203"}}],"responses":{"200":{"description":"大量保有関連の書類","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LargeHolding"}},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"},"finalized":{"type":"boolean","description":"過去日(確定済み)なら true。当日分は提出のたびに増える"}}}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/tender-offers":{"get":{"tags":["filings"],"operationId":"listTenderOffers","summary":"公開買付(TOB)関連書類","description":"公開買付届出書・撤回届出書・報告書・意見表明報告書などです。買付けの対象会社は `target` に入ります。","parameters":[{"name":"date","in":"query","description":"提出日(日本時間、YYYY-MM-DD)。省略時は今日。過去10年分まで","schema":{"type":"string","format":"date","example":"2026-10-01"}},{"name":"code","in":"query","description":"証券コードで絞り込む(対象会社・提出者のいずれかが一致)","schema":{"type":"string","example":"7203"}}],"responses":{"200":{"description":"TOB関連の書類","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Filing"}},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"},"finalized":{"type":"boolean","description":"過去日(確定済み)なら true。当日分は提出のたびに増える"}}}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/financials/{code}":{"get":{"tags":["financials"],"operationId":"getFinancials","summary":"有価証券報告書の財務・非財務データ","description":"証券コードと年を指定するだけで、有価証券報告書(XBRL)から抽出した数値を返します。開示のない項目は `null` です(推定で埋めません)。","parameters":[{"name":"code","in":"path","required":true,"description":"証券コード","schema":{"type":"string","example":"7203"}},{"name":"year","in":"query","description":"決算期末の西暦年。省略時は最新","schema":{"type":"integer","example":2025}},{"name":"metrics","in":"query","description":"取得する項目(カンマ区切り)。省略時は全項目。利用可能: sales, op, np, salesGrowth, equity, roe, per, payout, employees, avgSalary, avgAge, rdExpenses, capex, totalAssets, dps, tsr, shareholders, avgTenure, femaleManagerRatio, maleChildcareLeave, genderPayGap, crossHoldingsCount, crossHoldingsValue","schema":{"type":"string","example":"sales,op,avgSalary"}},{"name":"include","in":"query","description":"`lists` で大株主・政策保有株式の一覧も含める","schema":{"type":"string","enum":["lists"]}}],"responses":{"200":{"description":"財務データ。`meta.doc_id` が出典の有価証券報告書","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Financials"},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"type":"object","properties":{"doc_id":{"type":"string"},"doc_type":{"type":"string"},"submitted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"url":{"type":"string","format":"uri"}}}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/companies/{code}":{"get":{"tags":["companies"],"operationId":"getCompany","summary":"収録銘柄の指標(PER・PBR・ROE・配当利回りなど)","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","example":"7203"}}],"responses":{"200":{"description":"銘柄の指標","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Company"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/entities":{"get":{"tags":["entities"],"operationId":"searchEntities","summary":"再配布可能な法人データを検索","description":"法人名・法人番号・証券コードで検索します。データ元の最新の利用条件で再配布が認められた行だけを返し、個人のデータは除外します。","parameters":[{"name":"q","in":"query","required":true,"description":"法人番号(13桁)・証券コード、または法人名の先頭(前方一致。「株式会社」などの法人格は省略可。2〜100文字)","schema":{"type":"string","minLength":2,"maxLength":100,"example":"7203"}},{"name":"limit","in":"query","description":"最大件数(既定20、上限100)","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"offset","in":"query","description":"結果の開始位置(既定0。候補は最大200件なので上限199)","schema":{"type":"integer","minimum":0,"maximum":199,"default":0}}],"responses":{"200":{"description":"公開可能な法人の検索結果","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntitySummary"}},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"type":"object","properties":{"query":{"type":"string"},"count":{"type":"integer"},"has_more":{"type":"boolean","description":"続きの候補があるか(候補は最大200件。件数の総数は数えない)"},"limit":{"type":"integer"},"offset":{"type":"integer"}}}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/entities/{entityId}":{"get":{"tags":["entities"],"operationId":"getEntity","summary":"法人データの詳細","description":"主体IDを指定して、再配布可能な法人情報、履歴、書類、大量保有情報、出典を返します。個人データと再配布不可の行は除外されます。","parameters":[{"name":"entityId","in":"path","required":true,"description":"searchEntities が返す entity_id。例: jcn:1234567890123","schema":{"type":"string","maxLength":120}}],"responses":{"200":{"description":"法人の公開可能な詳細情報","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/EntityProfile"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/SubscriptionInactive"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/UpstreamError"},"503":{"$ref":"#/components/responses/Unavailable"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"購入時に発行される `vivl_live_…` のAPIキー"},"apiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"AlternativeEvent":{"type":"object","required":["id","dataset","source","company_code","title","event_on","submitted_at","retrieved_at","source_url","topic","entity_link","pit_ready"],"properties":{"id":{"type":"string"},"dataset":{"type":"string","enum":["annual_reports","tender_notices","policy_events"]},"source":{"type":"string"},"company_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"event_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"submitted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"retrieved_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"source_url":{"type":"string","format":"uri"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_link":{"type":"string","enum":["verified_code","not_linked"]},"pit_ready":{"type":"boolean","const":false}}},"Meta":{"type":"object","required":["source","fetched_at"],"properties":{"source":{"type":"string","enum":["EDINET","EDGAR","vivldatabase"],"description":"データの出典"},"fetched_at":{"type":"string","format":"date-time","description":"このレスポンスを組み立てた時刻"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","invalid_api_key","subscription_inactive","forbidden","not_found","method_not_allowed","rate_limited","plan_limit","internal_error","upstream_error","billing_unavailable","not_configured","sales_paused"]},"message":{"type":"string","description":"人が読むための説明(日本語)。分岐には code を使う"}},"additionalProperties":true}}},"CompanyRef":{"type":"object","required":["edinet_code","stock_code","name"],"properties":{"edinet_code":{"type":"string","example":"E02144"},"stock_code":{"anyOf":[{"type":"string","example":"7203"},{"type":"null"}]},"name":{"anyOf":[{"type":"string","example":"トヨタ自動車株式会社"},{"type":"null"}]}}},"Filing":{"type":"object","required":["doc_id","submitted_at","doc_type","category","is_correction","title","filer","issuer","target","period","url"],"properties":{"doc_id":{"type":"string","description":"EDINETの書類管理番号","example":"S100ABCD"},"submitted_at":{"anyOf":[{"type":"string","format":"date-time","example":"2026-10-01T15:00:00+09:00"},{"type":"null"}]},"doc_type":{"type":"object","required":["code","name"],"properties":{"code":{"type":"string","example":"350"},"name":{"type":"string","example":"大量保有報告書"}}},"category":{"type":"string","enum":["tob","largeHolding","extraordinary","buyback","offering","annual","quarterly","other"]},"is_correction":{"type":"boolean","description":"訂正書類なら true"},"title":{"anyOf":[{"type":"string","description":"書類の表題(EDINETの docDescription)"},{"type":"null"}]},"filer":{"type":"object","required":["name","edinet_code","stock_code","corporate_number"],"properties":{"name":{"type":"string"},"edinet_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"stock_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"corporate_number":{"anyOf":[{"type":"string","description":"法人番号(13桁)"},{"type":"null"}]}}},"issuer":{"anyOf":[{"$ref":"#/components/schemas/CompanyRef"},{"type":"null"}]},"target":{"anyOf":[{"$ref":"#/components/schemas/CompanyRef"},{"type":"null"}]},"period":{"anyOf":[{"type":"object","properties":{"start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}}},{"type":"null"}]},"url":{"type":"string","format":"uri","description":"EDINETの書類閲覧ページ"}}},"LargeHolding":{"allOf":[{"$ref":"#/components/schemas/Filing"},{"type":"object","required":["report_kind"],"properties":{"report_kind":{"type":"string","enum":["new","change","correction"],"description":"新規 / 変更報告書 / 訂正"}}}]},"Financials":{"type":"object","required":["code","name","fiscal_year","fiscal_period","financials"],"properties":{"code":{"type":"string"},"name":{"type":"string"},"sector":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year":{"type":"integer"},"fiscal_period":{"type":"object","properties":{"start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}}},"financials":{"type":"object","properties":{"sales":{"type":"object","description":"売上高(Net sales)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"億円"}}},"op":{"type":"object","description":"営業利益(Operating income)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"億円"}}},"np":{"type":"object","description":"当期純利益(親会社株主帰属)(Profit attributable to owners of parent)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"億円"}}},"salesGrowth":{"type":"object","description":"売上高成長率(前期比)(Sales growth (YoY))","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"equity":{"type":"object","description":"自己資本比率(Equity ratio)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"roe":{"type":"object","description":"ROE(自己資本利益率)(Return on equity)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"per":{"type":"object","description":"PER(提出時点)(P/E ratio (at filing))","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"倍"}}},"payout":{"type":"object","description":"配当性向(Payout ratio)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"employees":{"type":"object","description":"従業員数(連結)(Employees (consolidated))","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"名"}}},"avgSalary":{"type":"object","description":"平均年間給与(提出会社)(Average annual salary)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"万円"}}},"avgAge":{"type":"object","description":"平均年齢(提出会社)(Average age of employees)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"歳"}}},"rdExpenses":{"type":"object","description":"研究開発費(R&D expenses)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"億円"}}},"capex":{"type":"object","description":"設備投資額(Capital expenditures)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"億円"}}},"totalAssets":{"type":"object","description":"総資産(Total assets)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"億円"}}},"dps":{"type":"object","description":"1株当たり配当額(Dividend per share)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"円"}}},"tsr":{"type":"object","description":"株主総利回り(Total shareholder return)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"shareholders":{"type":"object","description":"株主数(Number of shareholders)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"名"}}},"avgTenure":{"type":"object","description":"平均勤続年数(提出会社)(Average years of service)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"年"}}},"femaleManagerRatio":{"type":"object","description":"女性管理職比率(Ratio of female managers)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"maleChildcareLeave":{"type":"object","description":"男性育児休業取得率(Male childcare leave rate)","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"genderPayGap":{"type":"object","description":"男女間賃金格差(女性/男性)(Gender pay gap (F/M))","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"%"}}},"crossHoldingsCount":{"type":"object","description":"政策保有株式 銘柄数(上場株)(Cross-shareholdings (issues))","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"銘柄"}}},"crossHoldingsValue":{"type":"object","description":"政策保有株式 計上額(上場株)(Cross-shareholdings (BS amount))","properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","const":"億円"}}}}},"major_shareholders":{"type":"array","items":{"type":"object"},"description":"include=lists のときのみ"},"holdings":{"type":"array","items":{"type":"object"},"description":"include=lists のときのみ"}}},"Company":{"type":"object","required":["code","name","metrics"],"properties":{"code":{"type":"string"},"name":{"type":"string"},"sector":{"anyOf":[{"type":"string"},{"type":"null"}]},"metrics":{"type":"object","additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]}}}},"EntitySummary":{"type":"object","required":["entity_id","jcn","name","sec_codes","sources"],"properties":{"entity_id":{"type":"string","example":"jcn:1234567890123"},"jcn":{"anyOf":[{"type":"string","pattern":"^\\d{13}$"},{"type":"null"}]},"name":{"type":"string"},"sec_codes":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","description":"この検索結果に使われた情報源と必要な帰属表記","items":{"type":"object","required":["source","name","attribution_text","terms_url"],"properties":{"source":{"type":"string"},"name":{"type":"string"},"attribution_text":{"anyOf":[{"type":"string"},{"type":"null"}]},"terms_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}}}}}},"EntityProfile":{"type":"object","required":["company","history","documents","large_holdings","sources"],"properties":{"company":{"type":"object","description":"法人の基本情報","additionalProperties":true},"history":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"名称・識別子・公開可能な属性の履歴"},"documents":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"公開可能な関連書類"},"large_holdings":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"公開可能な法人保有者の情報"},"facilities":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"保有不動産(有価証券報告書「主要な設備の状況」。帳簿価額・円、面積・㎡。検算に通った書類のみ)"},"facilities_check":{"anyOf":[{"type":"object","additionalProperties":true,"description":"保有不動産の元の書類と、提出会社の土地の合計 ÷ 個別貸借対照表の土地"},{"type":"null"}]},"sources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"出典・再配布条件・表示すべき帰属表記"}}}},"responses":{"BadRequest":{"description":"パラメータが不正(invalid_request)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"APIキーがない・不正(unauthorized / invalid_api_key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"SubscriptionInactive":{"description":"契約が有効でない(subscription_inactive)。/billing/manage から支払い方法を更新","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"該当データなし(not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"レート制限超過(rate_limited: 分間 / plan_limit: 月間)。Retry-After 秒後に再試行","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"UpstreamError":{"description":"EDINETからの取得に失敗(upstream_error)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"一時的に利用不可(billing_unavailable / not_configured)。時間をおいて再試行","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}