Skip to content

Adding news endpoints #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
e-roy merged 5 commits into from
Sep 26, 2025
Merged

Adding news endpoints #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1064787
update insider endpoints to stable
e-roy Sep 25, 2025
89f4d84
feat: add shares float and executive compenstion to tools
e-roy Sep 25, 2025
dfa8873
feat: add news endpoints
e-roy Sep 26, 2025
199f381
feat: improved docs layout
e-roy Sep 26, 2025
cccc1d7
choir: update changeset for new release
e-roy Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions apps/docs/src/app/docs/api/economic/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,29 +228,6 @@ console.log('Latest Unemployment:', unemployment.data[0]);`}

</CodeBlock>

## Error Handling

Always check the success property before accessing data:

<CodeBlock language="typescript">
{`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);
}`}

</CodeBlock>

## 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:
Expand All @@ -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.
156 changes: 123 additions & 33 deletions apps/docs/src/app/docs/api/insider/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<ApiTable
endpoints={[
{
method: 'GET',
path: '/insider-trading-rss-feed',
path: '/stable/insider-trading/latest',
description: 'Get real-time insider trading RSS feed',
},
{
method: 'GET',
path: '/insider-trading',
path: '/stable/insider-trading/search',
description: 'Search insider trades by symbol, CIK, or type',
},
{
method: 'GET',
path: '/insider-trading-transaction-type',
path: '/stable/insider-trading-transaction-type',
description: 'Get all insider transaction types',
},
{ method: 'GET', path: '/insider-roaster', description: 'Get insiders by symbol' },
{
method: 'GET',
path: '/insider-roaster-statistic',
path: '/v4/insider-roaster',
description: 'Get insiders by symbol (DEPRECATED)',
},
{
method: 'GET',
path: '/stable/insider-trading/statistics',
description: 'Get insider trade statistics',
},
{
method: 'GET',
path: '/mapper-cik-name',
description: 'Get CIK to name mapping or search by name',
path: '/v4/mapper-cik-name',
description: 'Get CIK to name mapping or search by name (DEPRECATED)',
},
{
method: 'GET',
path: '/mapper-cik-company/{symbol}',
description: 'Get CIK for a specific symbol',
path: '/v4/mapper-cik-company/{symbol}',
description: 'Get CIK for a specific symbol (DEPRECATED)',
},
{
method: 'GET',
path: '/insider/ownership/acquisition_of_beneficial_ownership',
path: '/stable/acquisition-of-beneficial-ownership',
description: 'Get beneficial ownership acquisitions',
},
{ method: 'GET', path: '/fail_to_deliver', description: 'Get fail to deliver data' },
{
method: 'GET',
path: '/v4/fail_to_deliver',
description: 'Get fail to deliver data (DEPRECATED)',
},
]}
/>

Expand All @@ -51,12 +61,23 @@ The Insider Trading Endpoints provide access to real-time and historical insider
## Get Insider Trading RSS Feed

<CodeBlock language="typescript">{`
const rssFeed = await fmp.insider.getInsiderTradingRSS({ page: 0 });
const rssFeed = await fmp.insider.getInsiderTradingRSS({ page: 0, limit: 100 });
`}</CodeBlock>

<ParameterTable
parameters={[
{ name: 'page', type: 'number', required: true, description: 'Page number for pagination' },
{
name: 'page',
type: 'number',
required: false,
description: 'Page number for pagination (default: 0)',
},
{
name: 'limit',
type: 'number',
required: false,
description: 'Limit number of results (default: 100)',
},
]}
/>

Expand All @@ -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'
}
]
}
Expand All @@ -83,7 +114,7 @@ const rssFeed = await fmp.insider.getInsiderTradingRSS({ page: 0 });
## Search Insider Trades

<CodeBlock language="typescript">{`
const trades = await fmp.insider.searchInsiderTrading({ symbol: 'AAPL', page: 0 });
const trades = await fmp.insider.searchInsiderTrading({ symbol: 'AAPL', page: 0, limit: 100 });
`}</CodeBlock>

<ParameterTable
Expand All @@ -107,7 +138,18 @@ const trades = await fmp.insider.searchInsiderTrading({ symbol: 'AAPL', page: 0
required: false,
description: 'Transaction type to filter by',
},
{ name: 'page', type: 'number', required: true, description: 'Page number for pagination' },
{
name: 'page',
type: 'number',
required: false,
description: 'Page number for pagination (default: 0)',
},
{
name: 'limit',
type: 'number',
required: false,
description: 'Limit number of results (default: 100)',
},
]}
/>

Expand All @@ -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'
}
]
}
Expand All @@ -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' }
]
}
`}</CodeBlock>
Expand All @@ -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.

<CodeBlock language="typescript">{`
const insiders = await fmp.insider.getInsidersBySymbol({ symbol: 'AAPL' });
`}</CodeBlock>
Expand Down Expand Up @@ -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
}
]
}
Expand All @@ -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.

<CodeBlock language="typescript">{`
const cikMapper = await fmp.insider.getCikMapper({ page: 0 });
`}</CodeBlock>
Expand Down Expand Up @@ -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.

<CodeBlock language="typescript">{`
const cikByName = await fmp.insider.getCikMapperByName({ name: 'zuckerberg', page: 0 });
`}</CodeBlock>
Expand Down Expand Up @@ -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.

<CodeBlock language="typescript">{`
const cikBySymbol = await fmp.insider.getCikMapperBySymbol({ symbol: 'MSFT' });
`}</CodeBlock>
Expand Down Expand Up @@ -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.

<CodeBlock language="typescript">{`
const failToDeliver = await fmp.insider.getFailToDeliver({ symbol: 'GE', page: 0 });
`}</CodeBlock>
Expand Down Expand Up @@ -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:

<CodeBlock language="typescript">{`
// 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');
`}</CodeBlock>

---

## Error Handling

Always check the `success` property before accessing `data`:
Expand Down
Loading