Spaces:
Runtime error
Runtime error
File size: 11,610 Bytes
98e3256 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 |
# API Usage Guide
Complete guide for using the SEC Financial Report MCP Server API.
## Base URL
After deployment: `https://YOUR_USERNAME-YOUR_SPACE_NAME.hf.space`
## Interactive Documentation
- **Swagger UI**: `{BASE_URL}/docs`
- **ReDoc**: `{BASE_URL}/redoc`
## Quick Start
### Python Example
```python
import requests
BASE_URL = "https://YOUR_SPACE_URL.hf.space"
# 1. Search company
response = requests.post(
f"{BASE_URL}/api/search_company",
json={"company_name": "NVIDIA"}
)
company = response.json()
print(f"Found: {company['name']} (CIK: {company['cik']})")
# 2. Get financial data
response = requests.post(
f"{BASE_URL}/api/get_financial_data",
json={"cik": company['cik'], "period": "2024"}
)
data = response.json()
print(f"Revenue: ${data['total_revenue']:,.0f}")
print(f"Net Income: ${data['net_income']:,.0f}")
print(f"EPS: ${data['earnings_per_share']:.2f}")
```
## Base URL
```
https://your-space-name.hf.space
```
## API Endpoints
### 1. Search Company by Name
**Endpoint:** `POST /api/search_company`
**Request:**
```json
{
"company_name": "NVIDIA"
}
```
**Response:**
```json
{
"cik": "0001045810",
"name": "NVIDIA CORP",
"ticker": "NVDA",
"error": null
}
```
**cURL Example:**
```bash
curl -X POST "https://your-space-name.hf.space/api/search_company" \
-H "Content-Type: application/json" \
-d '{"company_name": "NVIDIA"}'
```
**Python Example:**
```python
import requests
url = "https://your-space-name.hf.space/api/search_company"
payload = {"company_name": "NVIDIA"}
response = requests.post(url, json=payload)
print(response.json())
```
---
### 2. Get Company Information
**Endpoint:** `POST /api/get_company_info`
**Request:**
```json
{
"cik": "0001045810"
}
```
**Response:**
```json
{
"cik": "0001045810",
"name": "NVIDIA CORP",
"tickers": ["NVDA"],
"sic": "3674",
"sic_description": "Semiconductors & Related Devices",
"error": null
}
```
**cURL Example:**
```bash
curl -X POST "https://your-space-name.hf.space/api/get_company_info" \
-H "Content-Type: application/json" \
-d '{"cik": "0001045810"}'
```
**Python Example:**
```python
import requests
url = "https://your-space-name.hf.space/api/get_company_info"
payload = {"cik": "0001045810"}
response = requests.post(url, json=payload)
print(response.json())
```
---
### 3. Get Company Filings
**Endpoint:** `POST /api/get_company_filings`
**Request (All form types):**
```json
{
"cik": "0001045810",
"form_types": null
}
```
**Request (Specific form types):**
```json
{
"cik": "0001045810",
"form_types": ["10-K", "10-Q"]
}
```
**Response:**
```json
{
"filings": [
{
"form_type": "10-K",
"filing_date": "2024-02-21",
"accession_number": "0001045810-24-000029",
"primary_document": "nvda-20240128.htm"
},
{
"form_type": "10-Q",
"filing_date": "2024-05-22",
"accession_number": "0001045810-24-000067",
"primary_document": "nvda-20240428.htm"
}
],
"error": null
}
```
**cURL Example:**
```bash
curl -X POST "https://your-space-name.hf.space/api/get_company_filings" \
-H "Content-Type: application/json" \
-d '{"cik": "0001045810", "form_types": ["10-K", "10-Q"]}'
```
**Python Example:**
```python
import requests
url = "https://your-space-name.hf.space/api/get_company_filings"
payload = {
"cik": "0001045810",
"form_types": ["10-K", "10-Q"]
}
response = requests.post(url, json=payload)
print(response.json())
```
---
### 4. Get Company Facts
**Endpoint:** `POST /api/get_company_facts`
**Request:**
```json
{
"cik": "0001045810"
}
```
**Response:**
```json
{
"facts": {
"dei": {
"EntityCommonStockSharesOutstanding": {...},
"EntityPublicFloat": {...}
},
"us-gaap": {
"Revenues": {...},
"NetIncomeLoss": {...},
"EarningsPerShareBasic": {...}
}
},
"error": null
}
```
**cURL Example:**
```bash
curl -X POST "https://your-space-name.hf.space/api/get_company_facts" \
-H "Content-Type: application/json" \
-d '{"cik": "0001045810"}'
```
**Python Example:**
```python
import requests
url = "https://your-space-name.hf.space/api/get_company_facts"
payload = {"cik": "0001045810"}
response = requests.post(url, json=payload)
print(response.json())
```
---
### 5. Get Financial Data for Period
**Endpoint:** `POST /api/get_financial_data`
**Request (Annual Data):**
```json
{
"cik": "0001045810",
"period": "2024"
}
```
**Request (Quarterly Data):**
```json
{
"cik": "0001045810",
"period": "2024Q3"
}
```
**Response:**
```json
{
"period": "2024",
"total_revenue": 60922000000,
"net_income": 29760000000,
"earnings_per_share": 12.04,
"operating_expenses": 11822000000,
"operating_cash_flow": 28091000000,
"source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581024000029",
"source_form": "10-K",
"data_source": "us-gaap",
"additional_details": {
"total_revenue_details": {
"tag": "Revenues",
"form": "10-K",
"fy": 2024,
"fp": "FY",
"val": 60922000000,
"start": "2023-01-30",
"end": "2024-01-28",
"accn": "0001045810-24-000029",
"filed": "2024-02-21",
"frame": "CY2023",
"data_source": "us-gaap"
}
},
"error": null
}
```
**cURL Example:**
```bash
curl -X POST "https://your-space-name.hf.space/api/get_financial_data" \
-H "Content-Type: application/json" \
-d '{"cik": "0001045810", "period": "2024"}'
```
**Python Example:**
```python
import requests
url = "https://your-space-name.hf.space/api/get_financial_data"
payload = {
"cik": "0001045810",
"period": "2024"
}
response = requests.post(url, json=payload)
data = response.json()
print(f"Total Revenue: ${data['total_revenue']:,.0f}")
print(f"Net Income: ${data['net_income']:,.0f}")
print(f"EPS: ${data['earnings_per_share']:.2f}")
```
---
## Complete Python Client Example
```python
import requests
import json
class SECMCPClient:
"""Client for SEC Financial Report MCP Server"""
def __init__(self, base_url):
self.base_url = base_url.rstrip('/')
def search_company(self, company_name):
"""Search company by name"""
url = f"{self.base_url}/api/search_company"
response = requests.post(url, json={"company_name": company_name})
return response.json()
def get_company_info(self, cik):
"""Get company information"""
url = f"{self.base_url}/api/get_company_info"
response = requests.post(url, json={"cik": cik})
return response.json()
def get_company_filings(self, cik, form_types=None):
"""Get company filings"""
url = f"{self.base_url}/api/get_company_filings"
payload = {"cik": cik, "form_types": form_types}
response = requests.post(url, json=payload)
return response.json()
def get_company_facts(self, cik):
"""Get company facts"""
url = f"{self.base_url}/api/get_company_facts"
response = requests.post(url, json={"cik": cik})
return response.json()
def get_financial_data(self, cik, period):
"""Get financial data for period"""
url = f"{self.base_url}/api/get_financial_data"
payload = {"cik": cik, "period": period}
response = requests.post(url, json=payload)
return response.json()
# Usage example
if __name__ == "__main__":
# Initialize client
client = SECMCPClient("https://your-space-name.hf.space")
# Search for a company
company = client.search_company("NVIDIA")
print(f"Found: {company['name']} (CIK: {company['cik']})")
# Get company information
info = client.get_company_info(company['cik'])
print(f"Industry: {info['sic_description']}")
# Get recent filings
filings = client.get_company_filings(company['cik'], ["10-K"])
print(f"Recent 10-K filings: {len(filings['filings'])}")
# Get financial data for 2024
financial_data = client.get_financial_data(company['cik'], "2024")
print(f"FY2024 Revenue: ${financial_data['total_revenue']:,.0f}")
print(f"FY2024 Net Income: ${financial_data['net_income']:,.0f}")
print(f"FY2024 EPS: ${financial_data['earnings_per_share']:.2f}")
```
---
## Complete JavaScript/Node.js Client Example
```javascript
const axios = require('axios');
class SECMCPClient {
constructor(baseUrl) {
this.baseUrl = baseUrl.replace(/\/$/, '');
}
async searchCompany(companyName) {
const response = await axios.post(
`${this.baseUrl}/api/search_company`,
{ company_name: companyName }
);
return response.data;
}
async getCompanyInfo(cik) {
const response = await axios.post(
`${this.baseUrl}/api/get_company_info`,
{ cik: cik }
);
return response.data;
}
async getCompanyFilings(cik, formTypes = null) {
const response = await axios.post(
`${this.baseUrl}/api/get_company_filings`,
{ cik: cik, form_types: formTypes }
);
return response.data;
}
async getCompanyFacts(cik) {
const response = await axios.post(
`${this.baseUrl}/api/get_company_facts`,
{ cik: cik }
);
return response.data;
}
async getFinancialData(cik, period) {
const response = await axios.post(
`${this.baseUrl}/api/get_financial_data`,
{ cik: cik, period: period }
);
return response.data;
}
}
// Usage example
(async () => {
const client = new SECMCPClient('https://your-space-name.hf.space');
// Search for a company
const company = await client.searchCompany('NVIDIA');
console.log(`Found: ${company.name} (CIK: ${company.cik})`);
// Get financial data
const financialData = await client.getFinancialData(company.cik, '2024');
console.log(`FY2024 Revenue: $${financialData.total_revenue.toLocaleString()}`);
console.log(`FY2024 Net Income: $${financialData.net_income.toLocaleString()}`);
console.log(`FY2024 EPS: $${financialData.earnings_per_share.toFixed(2)}`);
})();
```
---
## Error Handling
All endpoints return standard HTTP status codes:
- **200 OK**: Successful request
- **422 Unprocessable Entity**: Invalid request parameters
- **500 Internal Server Error**: Server error
Error response format:
```json
{
"detail": "Error message description"
}
```
Or for API-specific errors:
```json
{
"error": "No company found matching 'INVALID_NAME'"
}
```
---
## Notes
- All monetary values are in USD (original values, not converted to millions)
- The `earnings_per_share` value is per share
- Data source: US SEC EDGAR system
- Supports US-GAAP and IFRS standards
- User-Agent: Juntao Peng (jtyxabc@gmail.com)
- Rate limiting follows SEC EDGAR API guidelines (10 requests per second)
---
## Interactive API Documentation
Once deployed, you can access interactive API documentation at:
- Swagger UI: `https://your-space-name.hf.space/docs`
- ReDoc: `https://your-space-name.hf.space/redoc`
|