{"openapi":"3.1.0","info":{"title":"Shikshan Nivesh Data API","version":"1.0.0","description":"US company data read from SEC filings, FINRA and House records: financial statements, revenue by segment, 8-K events, insider trades, planned sales, large holders, every 13F fund's holdings, House trades and short interest. Every row read from a filing carries that filing's address. A free key returns the last 5 fiscal years; a data plan returns the full record.","termsOfService":"https://shikshannivesh.com/data/licence","contact":{"email":"info@shikshannivesh.com"}},"servers":[{"url":"https://shikshannivesh.com/api/v1"}],"security":[{"bearer":[]},{"header":[]},{"query":[]}],"paths":{"/companies":{"get":{"summary":"Every company covered","description":"Ticker, name, exchange, industry, index and CIK for every company in the record.","responses":{"200":{"description":"The company list."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}":{"get":{"summary":"One company and its latest figures","description":"The company's identity, its latest reported figures (trailing twelve months, the latest quarter and year) and how many rows each dataset holds for it.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}}],"responses":{"200":{"description":"The company."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/financials":{"get":{"summary":"Income statement, balance sheet and cash flow","description":"Every year and quarter. As reported gives each line the way the company filed it, with the filing each figure came from. Standard gives the same named lines for every company, so companies compare directly. Periods are named by their month end; period_ends maps each one to the filing's own last day where it differs.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"basis","in":"query","description":"as-reported (the default) or standard.","schema":{"type":"string","enum":["as-reported","standard"],"default":"as-reported"}},{"name":"period","in":"query","description":"annual or quarterly. Leave it out for both.","schema":{"type":"string","enum":["annual","quarterly"]}}],"responses":{"200":{"description":"The statements."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/figures":{"get":{"summary":"Figures and ratios: revenue, margins, returns, growth, per share","description":"Every figure and ratio held for the company, by year, by quarter and on a trailing twelve months, with how each is worked out. Each period is named as the company names it (FY2025, Q3 FY2026) in periods. Share prices and anything worked out from them (P/E, market value, enterprise value, yields) are not served.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"ids","in":"query","description":"Figure ids separated by commas, like revenue,net_income,roic. Leave it out for every figure.","schema":{"type":"string"}},{"name":"period","in":"query","description":"annual, quarterly or ttm. Leave it out for all three.","schema":{"type":"string","enum":["annual","quarterly","ttm"]}}],"responses":{"200":{"description":"The figures."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/segments":{"get":{"summary":"Revenue by business, product and region","description":"Each year, as the company reports its segments.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}}],"responses":{"200":{"description":"The segments."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/events":{"get":{"summary":"Every 8-K, by the event it reports","description":"Each 8-K with its items, what they mean in plain words, the SEC acceptance time and the filing's address. Newest first.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The events."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/insider-trades":{"get":{"summary":"Form 4 trades","description":"Each trade with the date, who traded and their role, the kind of trade, shares, price, value and shares held after. Newest first.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The trades."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/insider-holdings":{"get":{"summary":"Insider holdings (Forms 3, 4 and 5)","description":"What each insider last reported holding, for each security and each way it is held: who, their role, the security, held directly or how it is held, shares, the date and the filing. Newest first.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The holdings."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/planned-insider-sales":{"get":{"summary":"Form 144 planned sales","description":"Each notice of a planned sale with who filed it, their relationship to the company, shares, value and the planned date. Newest first.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The planned sales."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/large-holders":{"get":{"summary":"13D and 13G filings","description":"Each large-holder filing and amendment with the holder, the percent and shares held and the event date. Newest first.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The large holders."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/congress-trades":{"get":{"summary":"House members' trades","description":"Each trade in the company's stock disclosed by a member of the House, with the trade date, the kind of trade, the value band and the report. Newest first.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The House trades."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/short-interest":{"get":{"summary":"Short interest","description":"Every FINRA settlement with shares short, the change, average daily volume and days to cover. Newest first.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The short interest."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/companies/{ticker}/fund-holders":{"get":{"summary":"Every fund holding the company","description":"Each fund's holding from its latest 13F, largest first: shares, value, the holding's share of the fund, the change in shares on the quarter before and the move (new, added, trimmed, exited, held, or first for a fund's first report). With it, history: each quarter since June 2013, how many funds reported the company, their shares on today's share basis and the value.","parameters":[{"name":"ticker","in":"path","required":true,"description":"The company's ticker, like AAPL. BRK.B and BRK-B both work.","schema":{"type":"string"}},{"name":"move","in":"query","description":"Only holders that made this move.","schema":{"type":"string","enum":["new","added","trimmed","exited","held","first"]}}],"responses":{"200":{"description":"The fund holders."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/macro":{"get":{"summary":"US economic series","description":"Every series held: Treasury yields, the Fed's rates, CPI, jobs, GDP and PCE, with the dates each covers.","parameters":[],"responses":{"200":{"description":"The series."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/macro/{series}":{"get":{"summary":"One economic series, as first printed and as revised","description":"Each period's latest value, the value first printed and the day it was first seen, and how many times it has been revised.","parameters":[{"name":"series","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The observations."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/funds":{"get":{"summary":"Every 13F fund","description":"Every manager that files its own 13F, largest first by reported value, with its CIK, address, latest quarter, filing date and number of positions.","parameters":[{"name":"q","in":"query","description":"Only funds whose name holds these words, or this CIK.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Funds per page, 1 to 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","description":"The next value from the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of funds."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/funds/{fund}":{"get":{"summary":"One fund's 13F holdings and moves","description":"The fund's latest quarter: every holding with shares, value, its share of the fund, the change in shares and the move on the quarter before, the value it held a quarter before, and the value and number of positions in every quarter it filed.","parameters":[{"name":"fund","in":"path","required":true,"description":"The fund's CIK, like 1067983, or its address, like berkshire-hathaway-inc-1067983.","schema":{"type":"string"}},{"name":"move","in":"query","description":"Only holdings with this move.","schema":{"type":"string","enum":["new","added","trimmed","exited","held"]}}],"responses":{"200":{"description":"The fund."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/datasets/{dataset}":{"get":{"summary":"One dataset across every company","description":"The newest 500 rows of a dataset across all companies, filtered by date, kind or ticker, in pages. A company's full history of a dataset comes from its own address above.","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string","enum":["insider-trades","planned-insider-sales","large-holders","short-interest","congress-trades","events","financial-statements","fund-holdings-13f"]}},{"name":"from","in":"query","description":"Only rows on or after this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Only rows on or before this date (year-month-day).","schema":{"type":"string","format":"date"}},{"name":"kind","in":"query","description":"Only rows of this kind, like Results or Leadership change for events, or New position for fund holdings.","schema":{"type":"string"}},{"name":"ticker","in":"query","description":"Only rows for this company.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Rows per page, 1 to 500.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"cursor","in":"query","description":"The next value from the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of rows."},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Authorization: Bearer sn_live_…"},"header":{"type":"apiKey","in":"header","name":"X-API-Key"},"query":{"type":"apiKey","in":"query","name":"api_key","description":"For spreadsheets that cannot send a header. Anyone who sees the address sees the key."}},"responses":{"Error":{"description":"Every error has the same shape.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string"},"request_id":{"type":"string"}}}}}}}}}},"x-limits":{"free":"250 calls a day (midnight UTC), at most 60 in a minute, the last 5 fiscal years","individual":"300 calls a minute, the full record","professional":"1,000 calls a minute, the full record"},"x-errors":[["missing_key",401,"No key was sent."],["invalid_key",401,"The key is not one of ours, or it was deleted."],["not_found",404,"No such address, company or dataset."],["bad_parameter",400,"A parameter is not one the address takes."],["rate_limited",429,"Over the calls a minute for this key. Wait a minute."],["daily_limit",429,"A free account's 250 calls for the day are used. They come back at midnight UTC."],["method_not_allowed",405,"The API only answers GET."],["unavailable",503,"Something on our side did not answer. Try again shortly."]]}