diff --git a/apps/docs/src/app/docs/api/economic/page.mdx b/apps/docs/src/app/docs/api/economic/page.mdx
index ddaf057..6567d1c 100644
--- a/apps/docs/src/app/docs/api/economic/page.mdx
+++ b/apps/docs/src/app/docs/api/economic/page.mdx
@@ -228,29 +228,6 @@ console.log('Latest Unemployment:', unemployment.data[0]);`}
-## Error Handling
-
-Always check the success property before accessing data:
-
-
-{`const rates = await fmp.economic.getTreasuryRates({
- from: '2024-01-01',
- to: '2024-01-31'
-});
-
-if (rates.success && rates.data) {
-console.log('Treasury Rates:', rates.data[0]);
-} else {
-console.error('Error:', rates.error);
-console.error('Status:', rates.status);
-}`}
-
-
-
-## Rate Limiting
-
-Economic endpoints are subject to FMP's rate limits. For production applications, implement appropriate rate limiting and caching strategies.
-
## Data Frequency
Economic data is typically updated:
@@ -269,7 +246,3 @@ Explore other endpoint categories:
- [Calendar Endpoints](/docs/api/calendar) - Earnings and economic calendars
- [List Endpoints](/docs/api/list) - Available symbols and instruments
- [Examples](/docs/examples) - Practical code samples
-
----
-
-**Ready to explore financial data?** Check out the [Financial Endpoints](/docs/api/financial) for income statements, balance sheets, and more.
diff --git a/apps/docs/src/app/docs/api/insider/page.mdx b/apps/docs/src/app/docs/api/insider/page.mdx
index e3d72c4..fde8ab4 100644
--- a/apps/docs/src/app/docs/api/insider/page.mdx
+++ b/apps/docs/src/app/docs/api/insider/page.mdx
@@ -2,47 +2,57 @@
The Insider Trading Endpoints provide access to real-time and historical insider trading data, transaction types, CIK mapping, beneficial ownership, and fail-to-deliver information. These endpoints help you analyze insider activity, compliance, and market sentiment.
+> **⚠️ Deprecation Notice:** Some endpoints use API version v4 which will be deprecated. Please use stable endpoints when available.
+
## Available Methods
@@ -51,12 +61,23 @@ The Insider Trading Endpoints provide access to real-time and historical insider
## Get Insider Trading RSS Feed
{`
-const rssFeed = await fmp.insider.getInsiderTradingRSS({ page: 0 });
+const rssFeed = await fmp.insider.getInsiderTradingRSS({ page: 0, limit: 100 });
`}
@@ -67,12 +88,22 @@ const rssFeed = await fmp.insider.getInsiderTradingRSS({ page: 0 });
success: true,
data: [
{
- title: '4 - Atlantic Union Bankshares Corp (0000883948) (Issuer)',
- fillingDate: '2022-10-05 13:43:47',
symbol: 'AUB',
- link: 'https://www.sec.gov/Archives/edgar/data/883948/000141588922010327/0001415889-22-010327-index.htm',
+ filingDate: '2022-10-05 13:43:47',
+ transactionDate: '2022-10-04',
reportingCik: '0001745407',
- issuerCik: '0000883948'
+ companyCik: '0000883948',
+ transactionType: 'S-Sale',
+ securitiesOwned: 50000,
+ reportingName: 'Atlantic Union Bankshares Corp',
+ typeOfOwner: 'officer: CEO',
+ acquisitionOrDisposition: 'D',
+ directOrIndirect: 'D',
+ formType: '4',
+ securitiesTransacted: 1000,
+ price: 25.50,
+ securityName: 'Common Stock',
+ url: 'https://www.sec.gov/Archives/edgar/data/883948/000141588922010327/0001415889-22-010327-index.htm'
}
]
}
@@ -83,7 +114,7 @@ const rssFeed = await fmp.insider.getInsiderTradingRSS({ page: 0 });
## Search Insider Trades
{`
-const trades = await fmp.insider.searchInsiderTrading({ symbol: 'AAPL', page: 0 });
+const trades = await fmp.insider.searchInsiderTrading({ symbol: 'AAPL', page: 0, limit: 100 });
`}
@@ -128,11 +170,12 @@ const trades = await fmp.insider.searchInsiderTrading({ symbol: 'AAPL', page: 0
companyCik: '0000320193',
reportingName: "O'BRIEN DEIRDRE",
typeOfOwner: 'officer: Senior Vice President',
- link: 'https://www.sec.gov/Archives/edgar/data/320193/000032019322000097/0000320193-22-000097-index.htm',
- securityName: 'Common Stock',
- price: 141.09,
+ acquisitionOrDisposition: 'D',
+ directOrIndirect: 'D',
formType: '4',
- acquistionOrDisposition: 'D'
+ price: 141.09,
+ securityName: 'Common Stock',
+ url: 'https://www.sec.gov/Archives/edgar/data/320193/000032019322000097/0000320193-22-000097-index.htm'
}
]
}
@@ -152,7 +195,24 @@ const types = await fmp.insider.getTransactionTypes();
{
success: true,
data: [
- 'J-Other', 'P-Purchase', 'W-Will', 'I-Discretionary', 'Z-Trust', 'F-InKind'
+ { transactionType: 'A-Award' },
+ { transactionType: 'C-Conversion' },
+ { transactionType: 'D-Return' },
+ { transactionType: 'E-ExpireShort' },
+ { transactionType: 'F-InKind' },
+ { transactionType: 'G-Gift' },
+ { transactionType: 'H-ExpireLong' },
+ { transactionType: 'I-Discretionary' },
+ { transactionType: 'J-Other' },
+ { transactionType: 'L-Small' },
+ { transactionType: 'M-Exempt' },
+ { transactionType: 'O-OutOfTheMoney' },
+ { transactionType: 'P-Purchase' },
+ { transactionType: 'S-Sale' },
+ { transactionType: 'U-Tender' },
+ { transactionType: 'W-Will' },
+ { transactionType: 'X-InTheMoney' },
+ { transactionType: 'Z-Trust' }
]
}
`}
@@ -161,6 +221,8 @@ const types = await fmp.insider.getTransactionTypes();
## Get Insiders by Symbol
+> **⚠️ Deprecated:** This endpoint uses API version v4 which will be deprecated. Please use stable endpoints when available.
+
{`
const insiders = await fmp.insider.getInsidersBySymbol({ symbol: 'AAPL' });
`}
@@ -207,15 +269,15 @@ const stats = await fmp.insider.getInsiderTradeStatistics({ symbol: 'AAPL' });
cik: '0000320193',
year: 2022,
quarter: 4,
- purchases: 6,
- sales: 30,
- buySellRatio: 0.2,
- totalBought: 1492148,
- totalSold: 2810029,
- averageBought: 248691.3333,
- averageSold: 93667.6333,
- pPurchases: 0,
- sSales: 15
+ acquiredTransactions: 6,
+ disposedTransactions: 30,
+ acquiredDisposedRatio: 0.2,
+ totalAcquired: 1492148,
+ totalDisposed: 2810029,
+ averageAcquired: 248691.3333,
+ averageDisposed: 93667.6333,
+ totalPurchases: 0,
+ totalSales: 15
}
]
}
@@ -225,6 +287,8 @@ const stats = await fmp.insider.getInsiderTradeStatistics({ symbol: 'AAPL' });
## Get CIK Mapper
+> **⚠️ Deprecated:** This endpoint uses API version v4 which will be deprecated. Please use stable endpoints when available.
+
{`
const cikMapper = await fmp.insider.getCikMapper({ page: 0 });
`}
@@ -253,6 +317,8 @@ const cikMapper = await fmp.insider.getCikMapper({ page: 0 });
## Get CIK Mapper by Name
+> **⚠️ Deprecated:** This endpoint uses API version v4 which will be deprecated. Please use stable endpoints when available.
+
{`
const cikByName = await fmp.insider.getCikMapperByName({ name: 'zuckerberg', page: 0 });
`}
@@ -287,6 +353,8 @@ const cikByName = await fmp.insider.getCikMapperByName({ name: 'zuckerberg', pag
## Get CIK Mapper by Symbol
+> **⚠️ Deprecated:** This endpoint uses API version v4 which will be deprecated. Please use stable endpoints when available.
+
{`
const cikBySymbol = await fmp.insider.getCikMapperBySymbol({ symbol: 'MSFT' });
`}
@@ -352,6 +420,8 @@ const beneficialOwnership = await fmp.insider.getBeneficialOwnership({ symbol: '
## Get Fail to Deliver Data
+> **⚠️ Deprecated:** This endpoint uses API version v4 which will be deprecated. Please use stable endpoints when available.
+
{`
const failToDeliver = await fmp.insider.getFailToDeliver({ symbol: 'GE', page: 0 });
`}
@@ -388,6 +458,26 @@ const failToDeliver = await fmp.insider.getFailToDeliver({ symbol: 'GE', page: 0
---
+## Convenience Methods
+
+The insider endpoints also provide convenience methods for common use cases:
+
+{`
+// Get insider trades for a specific symbol
+const appleTrades = await fmp.insider.getInsiderTradesBySymbol('AAPL');
+
+// Get insider trades by transaction type
+const purchases = await fmp.insider.getInsiderTradesByType('P-Purchase');
+
+// Get insider trades by reporting CIK
+const cikTrades = await fmp.insider.getInsiderTradesByReportingCik('0000320193');
+
+// Get insider trades by company CIK
+const companyTrades = await fmp.insider.getInsiderTradesByCompanyCik('0000320193');
+`}
+
+---
+
## Error Handling
Always check the `success` property before accessing `data`:
diff --git a/apps/docs/src/app/docs/api/layout.tsx b/apps/docs/src/app/docs/api/layout.tsx
index fe30d6b..4e0f292 100644
--- a/apps/docs/src/app/docs/api/layout.tsx
+++ b/apps/docs/src/app/docs/api/layout.tsx
@@ -2,6 +2,7 @@
import { Card, CardContent } from '@/components/ui/card';
import Link from 'next/link';
import { usePathname } from 'next/navigation';
+import { Footer } from '@/components/layout/footer';
const apiNavigationGroups = [
{
@@ -31,6 +32,7 @@ const apiNavigationGroups = [
items: [
{ name: 'Market Endpoints', href: '/docs/api/market' },
{ name: 'Economic Endpoints', href: '/docs/api/economic' },
+ { name: 'News Endpoints', href: '/docs/api/news' },
],
},
{
@@ -56,35 +58,38 @@ export default function APIDocsLayout({ children }: { children: React.ReactNode
const pathname = usePathname();
return (
-
- {/* Header */}
-
-
+
+ {/* Header - Fixed at top */}
+
+
-
+
← Back to Home
-
-
+
+
FMP Node API Documentation
-
Core API Wrapper
+
+ Core API Wrapper
+
-
+
- {/* Main content */}
-
-
- {/* Sidebar */}
-