Aumos

sec-edgar

aumos0.3.3
sec-edgar엔드포인트 2작성자가 기본값을 제공
원본 파일 보기문제 신고

SEC EDGAR

SEC EDGAR 자신의 엔드포인트를, 읽지 않은 채 에이전트에게 건넵니다.

Aumos는 SEC가 요구하는 연락처를 쥐고 요청에 서명합니다. 돌아오는 것은 SEC가 보낸 그대로이고, 그 사이에 매핑도 요약도 없습니다 — 이 소스는 어떤 포트도 선언하지 않으며, 이 페이지 옆의 source.json이 이 소스가 하는 일의 전부입니다.

무엇을 얻는가

제공EDGAR 자신의 엔드포인트를, 읽지 않고 그대로
닿는 곳www.sec.gov, data.sec.gov
충실도none — Aumos는 답을 읽지도, 날짜를 붙이지도 않습니다
커버리지CIK를 가진 미국 공시기업
비용무료. SEC는 이 데이터를 공개하며 호출자가 자신을 밝히기만을 요구합니다

**none이 정직한 충실도이고, 이 소스는 바로 그것을 위해 있습니다.** Aumos는 답을 자기 모양으로 접지 않고 날짜를 찍지도 않습니다. 응답은 SEC의 바이트 그대로이며, SEC가 보유한 모든 기간과 모든 정정을 담고 있습니다. 그래서 언제 알려져 있었는가를 판단하는 일은 호스트가 아니라 그것을 읽는 에이전트의 몫이고, 그 대가는 아래 라이브러리로서의 EDGAR에 적혀 있습니다.

어떤 소스도 할 수 없는 일은 그 공시가 참인지 확인하는 것입니다. 자기 회계를 잘못 진술한 회사는 공시한 그대로 보고됩니다. 어떤 데이터 소스도 달리 말해줄 수 없고, 이 소스도 그런 척하지 않습니다.

당신에게 요구하는 것

SEC는 모든 호출자가 자신을 밝히도록 요구하며, 그러지 않으면 403으로 답합니다. 그래서 이 소스는 하나를 요구합니다: 연락처 — 이름과 이메일 — 이며, 매 요청의 User-Agent로 전송됩니다.

패키지 작성자의 주소가 기본값으로 함께 배포되므로 설치하는 순간부터 동작합니다. 정기적으로 쓸 생각이라면 자기 주소를 넣는 편이 정직한 배치입니다: SEC의 호출 한도와 트래픽에 대한 모든 항의는 헤더의 주소를 따라갑니다. 설정 → 데이터 소스에서 입력하면 Aumos가 시스템 키체인에 보관하고, 어떤 에이전트도 그 값을 보지 못합니다.

라이브러리로서의 EDGAR

에이전트는 이 소스에게 EDGAR 자신의 엔드포인트를 물어 SEC가 보낸 것을 그대로 받을 수 있습니다 — 매핑 없이, 요약 없이, 고쳐 쓰는 일 없이. Aumos는 여전히 연락처를 쥐고 요청에 서명합니다. 하지 않는 것은 답을 읽는 일입니다.

에이전트가 물을 수 있는 것받는 것
/files/company_tickers.jsonSEC의 티커→CIK 표 전체 — 선택이 아니라 첫 번째 호출입니다
/api/xbrl/companyfacts/CIK{10자리}.jsonSEC가 그 공시기업에 대해 보유한 모든 XBRL 사실

에이전트에게 게시되는 allowlist 표기는 /api/xbrl/companyfacts/{symbol}이고, 거기의 **{symbol}은 티커가 아니라 파일명입니다.** SourceSpec/1의 자리표시자는 하나뿐이며 모든 문서에서 그 철자로 적힙니다. 이 엔드포인트에서 그 자리에 들어가는 것은 CIK + 10자리 zero-padded CIK + .json, 즉 INTC가 아니라 CIK0000050863.json입니다. 티커를 넣으면 404 NoSuchKey가 답하는데, 그것은 SEC가 이 공시기업에 대해 가진 것이 없다처럼 읽히지만 그런 뜻이 아닙니다. 그래서 위의 레지스트리 호출은 편의가 아니라 사실 조회의 전제조건이고, 그것이 돌려주는 cik_str은 정수(50863)라 호출자가 직접 10자리로 패딩합니다.

companyfacts는 한 공시기업의 XBRL 이력 전체입니다: SEC가 그 기업에 대해 보유한 모든 태그, 모든 기간, 그리고 기간마다의 모든 정정. 그 위에서 자기 계산을 하고 싶은 에이전트는 그것을 가질 수 있습니다. 반대로 골라지고 날짜가 붙은 몇 개의 수치를 원했던 에이전트는 여기서 그것을 얻지 못합니다. 이 경로에서는 아무것도 고르지 않고 아무것도 날짜를 붙이지 않기 때문입니다.

그래서 호출자에게 남는 것이 셋이고, 그중 무엇도 대신 해주지 않습니다:

  • Aumos가 확인한 날짜가 없습니다. 중계된 응답은 SEC가 넣어둔 것을 그대로 싣고, Aumos는 들여다보지 않습니다. 이것을 읽는 에이전트는 자신의 시점 고정 원칙을 스스로 책임집니다.
  • EDGAR 모양입니다. 이 두 엔드포인트를 상대로 쓰인 에이전트는 EDGAR를 상대로 쓰인 것이고, 다른 공시 소스로 향하게 하는 일은 다시 쓰는 일입니다.
  • 정정이 해소되지 않습니다. 한 기간이 두 번 이상 공시된 경우 응답은 그 전부를 싣습니다. 지난 3월에 대한 질문에 어느 것이 답하는지는 이 소스가 바이트를 건네기 전에 내린 결정이 아니라, 그것을 읽는 에이전트가 내리고 기록하는 결정입니다.

위의 경로가 목록 전부입니다 — 그 밖의 요청은 이름과 함께 거부됩니다. 문서가 거기에 선언할 수 있는 것에는 올릴 수 없는 천장이 있습니다: 어떤 문서도 브로커의 API로 중계할 수 없습니다. 브로커에서 읽는 자격증명은 곧 거래하는 자격증명이기 때문입니다.

하지 않는 일

  • 두 경로를 중계합니다. 시세, 뉴스, 텍스트로서의 공시, 애널리스트 추정치는 다른 소스입니다. 위의 두 경로가 이 소스의 전부입니다.
  • 요약하지 않습니다. Aumos는 도착한 응답을 그대로 건넵니다. 이 소스가 사람을 위해 쓰는 단 하나의 문장은 source.json의 caveat이고, 그것은 응답의 내용에 대한 해석이 아니라 이 엔드포인트를 어떻게 주소 지정하는지에 대한 경고입니다.
  • 다른 어디에도 닿지 않습니다. 위의 두 호스트는 Aumos가 설치한 문서에 선언된 것이고 요청할 수 있는 유일한 곳입니다. 다른 곳으로의 리다이렉트는 따라가는 대신 거부됩니다.

통화에 대한 고지

공시기업은 자기 수치를 어떤 단위로 보고하며, 둘 이상으로 보고하는 회사는 무엇을 그 재무제표의 통화라 부를지의 문제를 남깁니다. 여기서는 그 물음에 아무도 답하지 않습니다: companyfacts에서 사실들은 SEC가 기록한 단위를 키로 하는 units 객체 아래에 매달려 있고, Aumos는 그것을 도착한 그대로 건넵니다. 하나를 고르는 일 — 또는 고르기를 거절하고 그 사실을 판단에 적는 일 — 은 그것을 읽는 에이전트의 몫입니다.