{"openapi":"3.1.0","info":{"title":"Akila Financial Data API","version":"1.0.0","description":"As-reported US financial fundamentals from SEC XBRL, plus live quotes,\nvaluation multiples, comparables, disclosures, and a full-universe screener.\n\n## Authentication\nPass your API key in the `Authorization` header as a bearer token:\n\n```\nAuthorization: Bearer ak_live_xxxxxxxx\n```\n\nOr use the `X-Api-Key` header. Get a key at `/developers`.\n\n## Plans & quotas\n\n| Plan | Price | Calls/mo | Rate limit |\n|------|-------|----------|------------|\n| Free | Free | 1,000 | 10/min |\n| Starter | $29/mo | 50,000 | 60/min |\n| Pro | $99/mo | 500,000 | 300/min |\n| Business | $499/mo | 5,000,000 | 1000/min |\n\nEvery response includes `X-Quota-Remaining` and `X-RateLimit-Remaining` headers.\nExceeding a limit returns `429` with an `upgrade_url`.","contact":{"name":"Akyla","url":"http://app.akyla.ai/developers"},"termsOfService":"http://app.akyla.ai/docs","license":{"name":"Commercial","url":"http://app.akyla.ai/products/financial-data-api"}},"tags":[{"name":"Quotes","description":"Latest price snapshots and 52-week ranges."},{"name":"Fundamentals","description":"Key metrics and one-call fundamentals from SEC XBRL."},{"name":"Statements","description":"As-reported income, balance, cash-flow, and notes."},{"name":"Valuation","description":"Comparable companies and valuation multiples."},{"name":"Screener","description":"Filter the US-equity universe by valuation, size, growth, quality."}],"servers":[{"url":"http://app.akyla.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key"},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Api-Key"}}},"paths":{"/v1/quote/{ticker}":{"get":{"tags":["Quotes"],"operationId":"getQuote","summary":"Latest price quote","description":"Latest price snapshot and 52-week range. `?series=1` includes ~1y of daily closes.","parameters":[{"name":"ticker","in":"path","required":true,"description":"US-listed ticker symbol, e.g. AAPL.","schema":{"type":"string","example":"AAPL"}},{"name":"series","in":"query","required":false,"schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"type":"object","properties":{"ticker":{"type":"string"},"source":{"type":"string"},"api_version":{"type":"string","enum":["v1"]},"generated_at":{"type":"string","format":"date-time"}}}},"required":["data","meta"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}}}}},"/v1/fundamentals/{ticker}":{"get":{"tags":["Fundamentals"],"operationId":"getFundamentals","summary":"One-call fundamentals snapshot","description":"Latest key metrics (revenue, EBITDA, margins, EV/EBITDA, net debt, FCF) plus a live quote.","parameters":[{"name":"ticker","in":"path","required":true,"description":"US-listed ticker symbol, e.g. AAPL.","schema":{"type":"string","example":"AAPL"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"type":"object","properties":{"ticker":{"type":"string"},"source":{"type":"string"},"api_version":{"type":"string","enum":["v1"]},"generated_at":{"type":"string","format":"date-time"}}}},"required":["data","meta"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}}}}},"/v1/metrics/{ticker}":{"get":{"tags":["Fundamentals"],"operationId":"getMetrics","summary":"Key-metrics table across periods","description":"Columns = TTM + fiscal years; rows = revenue, EBITDA, margins, valuation multiples.","parameters":[{"name":"ticker","in":"path","required":true,"description":"US-listed ticker symbol, e.g. AAPL.","schema":{"type":"string","example":"AAPL"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"type":"object","properties":{"ticker":{"type":"string"},"source":{"type":"string"},"api_version":{"type":"string","enum":["v1"]},"generated_at":{"type":"string","format":"date-time"}}}},"required":["data","meta"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}}}}},"/v1/statements/{ticker}":{"get":{"tags":["Statements"],"operationId":"getStatement","summary":"As-reported financial statement","description":"XBRL-assembled statement (row schema + period columns + value grid). `?provenance=1` adds per-cell SEC filing attribution.","parameters":[{"name":"ticker","in":"path","required":true,"description":"US-listed ticker symbol, e.g. AAPL.","schema":{"type":"string","example":"AAPL"}},{"name":"type","in":"query","required":false,"description":"income | balance | cash","schema":{"type":"string","enum":["income","balance","cash"],"default":"income"}},{"name":"provenance","in":"query","required":false,"schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"type":"object","properties":{"ticker":{"type":"string"},"source":{"type":"string"},"api_version":{"type":"string","enum":["v1"]},"generated_at":{"type":"string","format":"date-time"}}}},"required":["data","meta"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}}}}},"/v1/comps/{ticker}":{"get":{"tags":["Valuation"],"operationId":"getComps","summary":"Comparable companies","description":"Subject company plus comparable peers with valuation multiples (P/E, P/S, EV/EBITDA, EV/UFCF).","parameters":[{"name":"ticker","in":"path","required":true,"description":"US-listed ticker symbol, e.g. AAPL.","schema":{"type":"string","example":"AAPL"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"type":"object","properties":{"ticker":{"type":"string"},"source":{"type":"string"},"api_version":{"type":"string","enum":["v1"]},"generated_at":{"type":"string","format":"date-time"}}}},"required":["data","meta"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}}}}},"/v1/notes/{ticker}":{"get":{"tags":["Statements"],"operationId":"getNotes","summary":"Notes & disclosures","description":"Revenue disaggregation, inventory components, PPE, goodwill, debt, and leases from dimensional XBRL.","parameters":[{"name":"ticker","in":"path","required":true,"description":"US-listed ticker symbol, e.g. AAPL.","schema":{"type":"string","example":"AAPL"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["annual","quarterly"],"default":"annual"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"},"meta":{"type":"object","properties":{"ticker":{"type":"string"},"source":{"type":"string"},"api_version":{"type":"string","enum":["v1"]},"generated_at":{"type":"string","format":"date-time"}}}},"required":["data","meta"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}}}}},"/v1/screener":{"get":{"tags":["Screener"],"operationId":"getScreener","summary":"Screen the US-equity universe","description":"Filter ~5–8k US equities. Numeric filters use `<field>_<op>` (op ∈ gt|gte|lt|lte), e.g. `?marketCap_gt=1000&pe_lt=20&ebitdaMargin_gte=0.2`. Text: `?sector=software&exchange=NASDAQ`. Paging/sort: `?limit=50&offset=0&sort=marketCap&order=desc`.","parameters":[{"name":"sector","in":"query","required":false,"schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"maximum":500}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"marketCap"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object"}},"count":{"type":"integer"},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}}},"meta":{"type":"object","properties":{"ticker":{"type":"string"},"source":{"type":"string"},"api_version":{"type":"string","enum":["v1"]},"generated_at":{"type":"string","format":"date-time"}}}},"required":["data","meta"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs_url":{"type":"string"}}}}}}}}}}}}}