Skip to content

Commit 48ebe49

Browse files
pacphipacphi
committed
Swap Edgar for Kaleidoscope API for onbtaining financial filing data
1 parent 5dbceec commit 48ebe49

28 files changed

+1036
-800
lines changed

‎.env.example‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ LLM_API_KEY=your_key_here # Maps to API_KEY in the appl
4444
# Financial advisor using PHP Symfony and Neuron
4545
STOCK_API_KEY=your_key_here # Required for stock market data
4646
# Obtain from: https://www.alphavantage.co/support/#api-key
47-
EDGAR_API_KEY=your_key_here # Required for SEC EDGAR database access
48-
# Obtain from: https://www.sec.gov/edgar/sec-api-documentation
47+
KALEIDOSCOPE_API_KEY=your_key_here # Required for SEC filing data from Kaleidoscope API
48+
# Obtain from: https://api.kscope.io/signup
4949
LINKEDIN_CLIENT_ID=your_id_here # Required for LinkedIn integration
5050
LINKEDIN_CLIENT_SECRET=your_secret_here # Required for LinkedIn integration
5151
# Obtain both from: https://www.linkedin.com/developers/apps/new

‎.github/workflows/deploy-php-symfony-neuron-to-tp4cf.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ on:
5555
NEWS_API_KEY:
5656
required: false
5757
description: 'News API Key'
58-
EDGAR_API_KEY:
58+
KALEIDOSCOPE_API_KEY:
5959
required: false
60-
description: 'Edgar API Key'
60+
description: 'Kaleidoscope API Key for SEC filings'
6161
OPENAI_API_KEY:
6262
required: false
6363
description: 'OpenAI API Key'
@@ -109,7 +109,7 @@ jobs:
109109
echo '{
110110
"STOCK_API_KEY": "${{ secrets.STOCK_API_KEY }}",
111111
"NEWS_API_KEY": "${{ secrets.NEWS_API_KEY }}",
112-
"EDGAR_API_KEY": "${{ secrets.EDGAR_API_KEY }}",
112+
"KALEIDOSCOPE_API_KEY": "${{ secrets.KALEIDOSCOPE_API_KEY }}",
113113
"OPENAI_API_KEY": "${{ secrets.OPENAI_API_KEY }}",
114114
"LINKEDIN_CLIENT_ID": "${{ secrets.LINKEDIN_CLIENT_ID }}",
115115
"LINKEDIN_CLIENT_SECRET": "${{ secrets.LINKEDIN_CLIENT_SECRET }}"

‎.github/workflows/deploy-to-tp4cf.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ jobs:
181181
CF_SSO_REFRESH_TOKEN: ${{ secrets.CF_SSO_REFRESH_TOKEN }}
182182
STOCK_API_KEY: ${{ secrets.STOCK_API_KEY }}
183183
NEWS_API_KEY: ${{ secrets.NEWS_API_KEY }}
184-
EDGAR_API_KEY: ${{ secrets.EDGAR_API_KEY }}
184+
KALEIDOSCOPE_API_KEY: ${{ secrets.KALEIDOSCOPE_API_KEY }}
185185
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
186186
LINKEDIN_CLIENT_ID: ${{ secrets.LINKEDIN_CLIENT_ID }}
187187
LINKEDIN_CLIENT_SECRET: ${{ secrets.LINKEDIN_CLIENT_SECRET }}

‎DEPLOY.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ You **must** configure the following secrets in your repository for the applicat
4242
| `OPENAI_API_KEY` | `java-spring-ai-mcp/client`, `java-spring-langgraph-mcp-angular`, `php-symfony-neuron`, `py-django-crewai` | `SPRING_AI_OPENAI_API_KEY` (Java), `OPENAI_API_KEY` (PHP/Python) |
4343
| `TICKETMASTER_API_KEY` | `java-spring-langgraph-mcp-angular` | `TICKETMASTER_API_KEY` |
4444
| `CITIES_API_KEY` | `java-spring-langgraph-mcp-angular` | `CITIES_API_KEY` |
45-
| `NEWS_API_KEY` | `js-langchain-react`, `php-symfony-neuron` | `NEWS_API_KEY` |
45+
| `NEWS_API_KEY` | `js-langchain-react`, `php-symfony-neuron` | `NEWS_API_KEY` |
4646
| `LLM_API_KEY` | `js-langchain-react` | `API_KEY` |
4747
| `STOCK_API_KEY` | `php-symfony-neuron` | `STOCK_API_KEY` |
48-
| `EDGAR_API_KEY` | `php-symfony-neuron` | `EDGAR_API_KEY` |
48+
| `KALEIDOSCOPE_API_KEY` | `php-symfony-neuron` | `KALEIDOSCOPE_API_KEY` |
4949
| `LINKEDIN_CLIENT_ID` | `php-symfony-neuron` | `LINKEDIN_CLIENT_ID` |
5050
| `LINKEDIN_CLIENT_SECRET` | `php-symfony-neuron` | `LINKEDIN_CLIENT_SECRET` |
5151
| `DJANGO_SECRET_KEY` | `py-django-crewai` | `DJANGO_SECRET_KEY` |

‎TOOLS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,8 @@ Various projects require API keys for external services:
276276
- **Stock API Key**: Required for php-symfony-neuron
277277
- Various providers available (Alpha Vantage, Finnhub, etc.)
278278

279-
- **Edgar API Key**: Required for php-symfony-neuron
280-
- SEC EDGAR database access
279+
- **Kaleidoscope API Key**: Required for php-symfony-neuron
280+
- SEC filings database access
281281

282282
- **LinkedIn API Credentials**: Required for php-symfony-neuron
283283
- **Sign up**: [https://www.linkedin.com/developers/](https://www.linkedin.com/developers/)

‎php-symfony-neuron/.env.example‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ GENAI_MODEL=gpt-4o-mini
2020
###> Financial API Keys ###
2121
# Alpha Vantage API key (used as the primary stock data provider)
2222
ALPHA_VANTAGE_API_KEY=your_alpha_vantage_api_key
23-
# Yahoo Finance API key (used as a fallback for stock data)
24-
YAHOO_FINANCE_API_KEY=your_yahoo_finance_api_key
23+
# Rapid (Nokia) API Key; vends former Yahoo Finance data (used as a fallback for stock data)
24+
RAPID_API_KEY=your_rapid_api_key
2525
# News API key (used for fetching financial news)
2626
NEWS_API_KEY=your_news_api_key
27-
# SEC EDGAR API (no API key required, but requires a User-Agent with contact info)
28-
SEC_EDGAR_USER_AGENT="PHP/Symfony/NeuronAI Company Research Assistant [email protected]"
27+
# Kaleidoscope API (used for all SEC filings)
28+
KALEIDOSCOPE_API_KEY=your_kaleidoscope_api_key
2929
###< Financial API Keys ###
3030

3131
###> LinkedIn API Integration ###

‎php-symfony-neuron/ci/bitbucket/bitbucket-pipelines.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ pipelines:
140140
cf set-env "$APP_NAME" "NEWS_API_KEY" "$NEWS_API_KEY"
141141
fi
142142
143-
if [ -n "$EDGAR_API_KEY" ]; then
144-
cf set-env "$APP_NAME" "EDGAR_API_KEY" "$EDGAR_API_KEY"
143+
if [ -n "$KALEIDOSCOPE_API_KEY" ]; then
144+
cf set-env "$APP_NAME" "KALEIDOSCOPE_API_KEY" "$KALEIDOSCOPE_API_KEY"
145145
fi
146146
147147
if [ -n "$OPENAI_API_KEY" ]; then
@@ -175,7 +175,7 @@ options:
175175
# RANDOM_ROUTE: Whether to use a random route (true/false)
176176
# STOCK_API_KEY: Stock API key
177177
# NEWS_API_KEY: News API key
178-
# EDGAR_API_KEY: Edgar API key
178+
# KALEIDOSCOPE_API_KEY: Kaleidoscope API key
179179
# OPENAI_API_KEY: OpenAI API key
180180
# LINKEDIN_CLIENT_ID: LinkedIn Client ID
181181
# LINKEDIN_CLIENT_SECRET: LinkedIn Client Secret

‎php-symfony-neuron/ci/gitlab/.gitlab-ci.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ deploy:
126126
RANDOM_ROUTE: "false"
127127
STOCK_API_KEY: ""
128128
NEWS_API_KEY: ""
129-
EDGAR_API_KEY: ""
129+
KALEIDOSCOPE_API_KEY: ""
130130
OPENAI_API_KEY: ""
131131
LINKEDIN_CLIENT_ID: ""
132132
LINKEDIN_CLIENT_SECRET: ""
@@ -180,8 +180,8 @@ deploy:
180180
cf set-env "$APP_NAME" "NEWS_API_KEY" "$NEWS_API_KEY"
181181
fi
182182
183-
if [ -n "$EDGAR_API_KEY" ]; then
184-
cf set-env "$APP_NAME" "EDGAR_API_KEY" "$EDGAR_API_KEY"
183+
if [ -n "$KALEIDOSCOPE_API_KEY" ]; then
184+
cf set-env "$APP_NAME" "KALEIDOSCOPE_API_KEY" "$KALEIDOSCOPE_API_KEY"
185185
fi
186186
187187
if [ -n "$OPENAI_API_KEY" ]; then

‎php-symfony-neuron/ci/jenkins/Jenkinsfile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ pipeline {
149149
booleanParam(name: 'RANDOM_ROUTE', defaultValue: false, description: 'Use random route for the application')
150150
password(name: 'STOCK_API_KEY', defaultValue: '', description: 'Stock API Key')
151151
password(name: 'NEWS_API_KEY', defaultValue: '', description: 'News API Key')
152-
password(name: 'EDGAR_API_KEY', defaultValue: '', description: 'Edgar API Key')
152+
password(name: 'KALEIDOSCOPE_API_KEY', defaultValue: '', description: 'Kaleidoscope API Key')
153153
password(name: 'OPENAI_API_KEY', defaultValue: '', description: 'OpenAI API Key')
154154
password(name: 'LINKEDIN_CLIENT_ID', defaultValue: '', description: 'LinkedIn Client ID')
155155
password(name: 'LINKEDIN_CLIENT_SECRET', defaultValue: '', description: 'LinkedIn Client Secret')
@@ -214,8 +214,8 @@ pipeline {
214214
cf set-env "$APP_NAME" "NEWS_API_KEY" "${NEWS_API_KEY}"
215215
fi
216216
217-
if [ -n "${EDGAR_API_KEY}" ]; then
218-
cf set-env "$APP_NAME" "EDGAR_API_KEY" "${EDGAR_API_KEY}"
217+
if [ -n "${KALEIDOSCOPE_API_KEY}" ]; then
218+
cf set-env "$APP_NAME" "KALEIDOSCOPE_API_KEY" "${KALEIDOSCOPE_API_KEY}"
219219
fi
220220
221221
if [ -n "${OPENAI_API_KEY}" ]; then

‎php-symfony-neuron/config/packages/edgar_api.yaml‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)