backgroundbackground
General
What is SEC API?

FinFeedAPI offers an SEC API that provides programmatic access to U.S. Securities and Exchange Commission (SEC) filings. This API allows developers to retrieve and analyze SEC data, such as 10-Ks, 8-Ks, and insider trades, directly within their applications. The data is available in a structured, machine-readable format, making it easier to integrate into analytical tools. Here's a breakdown of the key features and benefits:

  • Access to SEC Filings:The API provides access to a wide range of SEC documents, including company performance data, significant corporate events, and insider transactions.
  • Structured Data:The data is provided in a structured format, making it easier to parse and analyze.
  • Real-time and Historical Data:The API offers both real-time and historical data access, allowing users to track changes and analyze trends over time.
  • Integration with MCP:FinFeedAPI's SEC API is designed to be integrated with the Model Context Protocol (MCP), which enables AI agents to interact with the API and automate tasks related to SEC data analysis.
  • Applications:Developers can use the SEC API for various purposes, including financial analysis, research, and compliance monitoring.

Example Use Cases:

  • Financial Analysis:Analyze company performance, identify potential risks, and track insider activity.
  • Research:Conduct research on specific companies or industries by accessing their SEC filings.
  • Compliance Monitoring:Monitor regulatory filings for compliance purposes.
  • Automated Reporting:Integrate the API with AI agents to automate report generation based on SEC data.
What SEC forms does the API cover?

The API provides access to the vast majority of the 400+ form types filed electronically via EDGAR since the mid-1990s. This includes key forms like 10-K, 10-Q, 8-K, S-1, Forms 3, 4, 5, Schedule 13D/G, 13F-HR, DEF 14A, 424B prospectuses, and many others.

How up-to-date is the data? How quickly are new filings available?

The API provides near real-time access. New filings are typically processed and made available via the API within milliseconds to seconds of their official publication on the SEC EDGAR system.

Is the data specific to certain stock exchanges, or does it cover all U.S. public companies?

The data is company-specific, not exchange-specific. You can access filings from all U.S. public companies, regardless of the exchange on which their shares are traded.

What is the historical depth of the data?

The API offers access to historical filings dating back to the inception of mandatory electronic filing, typically 1993/1994 , providing over 30 years of data.

What format is the data delivered in?

The primary data format is standardized JSON, designed for ease of parsing and integration into applications. Filing metadata and extracted content are provided in this format. The API also allows retrieval of original filing documents in their native formats (HTML, PDF, TXT, XBRL, etc.)

What does autoscaling mean for users?

It means our system is designed to handle a high volume of requests. We dynamically adjust our resources to accommodate the load in real-time, so you experience fewer limitations compared to systems with fixed rate limits based on subscription tiers.

How is my data confidentiality handled, especially if I'm using the API under an NDA?

We treat your data with the utmost confidentiality, as outlined in the agreement you sign as a new customer. We understand that API requests, support interactions, and logs might contain sensitive information or your "secret sauce." We are committed to ensuring this information is never disclosed.

What is Download API?

Download API provides direct access to download full filings, acting as a mirror of the SEC database but without the rate limits often encountered when accessing the SEC directly.

What can I expect to receive from a single API call?

Each API call returns a response specific to the query you made. This could be metadata for filings, extracted data items, full-text search results, or the content of a downloaded filing, depending on the endpoint and parameters used.

How is the API's full-text search different from using the search on the SEC's website?

Our API's full-text search operates on our indexed database of SEC filings. This allows for more complex queries, faster retrieval, and integration into your automated workflows and applications, which is often not feasible or efficient using the SEC's public website search directly for large-scale analysis.

Can the API help analyze the content or sentiment of sections like "Risk Factors," beyond just their length?

Currently SEC API can help you with analyzing the length. However, we plan to expand on this by showing how you can integrate our API with Large Language Models (LLMs) or other sentiment analysis tools to gain deeper insights into the content.

Is there an API endpoint to check my usage, or is it only visible on the dashboard?

Currently, FinFeedAPI does not provide a dedicated API endpoint for tracking usage metrics. The best way to monitor your usage is through the Customer Portal's dashboard, which offers real-time tracking and historical views of:

  • API credits used
  • Data transferred (Tier 1 & Tier 2 for WebSocket)
  • Flat Files usage
  • Billing activity

We recommend logging in to your Customer Portal and navigating to the Usage Metrics or Billing sections for the most accurate and up-to-date information.

Can I get a custom plan based on my data needs?

Yes, FinFeedAPI offers custom subscription plans tailored to meet specific data requirements and business needs. If your organization requires specialized data sets, higher rate limits, or unique integration support beyond the standard subscription offerings, you can reach out to our sales team to discuss a customized solution.

Are subscription payments executed automatically?

Yes, subscription payments are executed automatically on your primary payment method when the subscription remains active.

Can I have multiple API keys in one account?

Yes, it's possible to have multiple API keys for the same subscription. In the Customer Portal, navigate to API Keys > Create Standard API Key. It is important to note that the existence of each additional API Key for a subscription (enabled or disabled) above the plan quota is charged 1 USD per day, with a minimum of one day.

Using multiple API keys helps improve security and manageability by allowing separation between environments (e.g., development, testing, production), tracking usage per product or service, isolating potential issues, and simplifying key rotation without impacting unrelated systems.

Can I have multiple subscriptions?

Yes, you may have multiple subscriptions.

Multiple subscriptions are commonly used when:

  • The software is shipped to multiple third-party's by the customer (eg. self-hosted software)
  • To separate environments inside the company (development, testing, staging, production)
  • To separate multiple independent production sites (Europe, Asia, etc)
  • To separate multiple teams inside the company working on different features or products
Can I participate in the FinFeedAPI GitHub repository?

Yes, please do!

  1. Sign in on the GitHub
  2. Fork our main GitHub repository: https://github.com/api-bricks/api-bricks-sdk
  3. Work on the changes and push them into your forked repository
  4. When you are ready to share the changes with us. Create "Pull Request” to our main repository with a short description of the changes.
Do you offer discount for university/non-profit/research-only usage?

We do not have a special plan for such cases, however we will be happy to speak with you to discuss your requirements and the best plan & pricing that will fit your needs!

Do you have a Status Page?

Yes, we have a Status Page at: https://status.finfeedapi.com

How can I set custom timezone in the data?

We do not support custom timezones, data is always processed in the UTC.

If you need to operate in the custom timezone then input and output values should be converted on the client-side before a request is sent to us or output data processed.

In the corner cases like OHLCV data on the higher than 1HRS periods (eg. 1DAY), you should execute queries only to the 1HRS period at the maximum and assemble higher periods like 1DAY on the client-side, as our 1DAY always starts and ends at the UTC midnight.

Does FinFeedAPI offer SLAs (Service Level Agreements) for enterprise clients?

Yes, CoinAPI provides Service Level Agreements (SLAs) tailored specifically for enterprise clients. These SLAs define key performance and reliability metrics to support mission-critical applications, including:

  • Guaranteed uptime and availability targets
  • Maximum response time thresholds
  • Dedicated support availability and escalation paths
  • Incident response and resolution timelines

SLAs are structured to meet the needs of high-throughput trading platforms, institutional users, and large-scale data consumers who rely on consistent and predictable API behavior.

To discuss SLA options and terms, please contact our sales team.

How long does it take to integrate FinFeedAPI?

You can generate an API Key via the Customer Portal. Once you have your API key, you can begin making requests immediately.

The actual integration time depends on the complexity of your project:

  • For simple use cases, setup can take as little as 5 minutes
  • For more complex systems (e.g., production-grade trading platforms or data pipelines), integration may take several days

Our SDKs, documentation, and sample code are designed to help accelerate the process, regardless of your environment or programming language.

How can I be notified about FinFeedAPI issues or incidents?

To stay informed about service status, outages, or scheduled maintenance, CoinAPI provides a dedicated status page. We recommend subscribing to email notifications directly on the page to receive real-time alerts.

If you encounter an issue that is not reflected on the status page or disagree with its current content, please report it using our support form.

Is there an SLA agreement available with FinFeedAPI?

Yes, FinFeedAPI provides a standard Service Level Agreement (SLA) for all paid plans. This covers key performance metrics such as uptime, availability, and support responsiveness.

If your organization requires a custom SLA, this is available through our Enterprise Plan. Custom SLAs can include specific commitments around latency, incident response times, and dedicated infrastructure options.

To discuss custom SLA requirements, please contact our sales team.

Should I file a support ticket every time we experience a problem?

Yes, you should file a support ticket whenever an issue occurs. This is essential even if the problem seems temporary or intermittent.

Here’s why:

  • Your support SLA (if applicable) is only activated when a ticket is submitted.
  • Without a formal ticket, we cannot guarantee prioritization, investigation, or tracking of the issue.
  • If your plan does not include a service-level SLA, we do not monitor or proactively respond to issues unless they are reported.

For customers with custom SLAs, we track specific metrics and build infrastructure to meet those guarantees. For all other users, we rely on incoming tickets to understand what matters to your business.

Our process:

  • We continuously monitor infrastructure and act on system-level issues.
  • However, without ticket input, we may not detect or be accountable for individual cases that affect your workflow.
  • If needed, we expand monitoring and internal metrics based on patterns in submitted tickets.

You can submit a new ticket here.

Do you offer integration assistance or paid onboarding support?

Yes, FinFeedAPI offers integration assistance as part of our Enterprise tier. This support can be tailored to your technical architecture, workflow requirements, and business objectives.

If you’re interested in hands-on onboarding, architecture reviews, or guided implementation, please contact our team to discuss the best setup for your use case.

API usage, credits and limits
How does FinFeedAPI credit system work? Do I need to preload credits, and how fast are charges reflected?

Yes, to use credit-based services like Flat Files or REST API access, you must preload usage credits to your account. Here's how it works:

Preloading Credits

  • Once you link your credit card, you’ll need to manually add credits through the Billing > Add Usage Credits section in your dashboard.
  • Optionally, you can enable Auto Recharge, which automatically tops up your credits once your balance falls below a defined threshold.

How Charges Work

  • Credits are prepaid, meaning you load your account before downloading data.
  • The cost of your activity (e.g., API calls, Flat File access) is deducted from your available credit balance.

Processing Time

  • Credit top-ups are processed in near real-time.
  • Your available balance updates almost immediately after the credit card is charged.
  • Only exception: crypto payments may have a short delay (up to 1 hour) due to blockchain confirmation times.

Usage Credits Documentation

How do I enable overcharge?

If you are finding that you are always requiring more daily requests, one way to circumvent this is by enabling Spend Management and Auto Recharge, wherein you can go above the limit of requests per day.

You may enable Spend Management and Auto Recharge through the Customer Portal

You may read more about these features here:

What happens if I exceed my daily REST API request limit on my plan?

If your subscription has a hard limit, exceeding your daily REST API quota will trigger an HTTP 429 Too Many Requests error response. This means no further requests will be processed until your 24-hour rolling window resets.

For soft-limited plans, we may allow overages temporarily, but we will contact you if usage consistently exceeds your plan limits, prompting an upgrade discussion.

How to Monitor Usage:

  • Use our Subscription Management API to track usage and quotas in real-time: View Subscription API Docs
  • Review HTTP status codes and errors
Why do some API responses not include rate limit headers?

The reason why response headers are not always present in the API responses is that, in some cases, we are unaware of their specific usage or requirements. To ensure that we promptly respond to your API calls and avoid unnecessary delays, we choose to provide a response without including the response headers. This decision is made with the intention of optimizing the operation of our API. By selectively excluding the inclusion of response headers in every request, we can enhance the overall performance and efficiency of the API.

It takes a while to verify the current usage as for the very first call for a given client we do not have a rate limit then yet. Once the request is made, we start the rate limit verification process In the background. We may then in the meantime process many requests for this client and at some point we append the result of current usage to the header. All requests that were made during that process are also included in the limit after some time.

For example (each bullet point representing a request made):

  • Request (no info about clients usage)
  • What's the usage? Starting the verification
  • Request
  • Request
  • 5 requests used today (those 3 above are not counted yet), appended to the header
  • Request (5 used)
  • Request (5 used)
  • Request (5 used)
  • Request (5 used)
  • Request (10 requests used today)
How can I check my historical API usage?

You can view your past API usage directly in the FinFeedAPI Customer Portal:

  1. Log in at: https://console.finfeedapi.com
  2. Navigate to the Usage Explorer tab
  3. Review your usage breakdown by using the Metrics available on the dropdown and filter by selecting a date range.

Additionally, for real-time tracking, you may refer to the Quotas and Limits section of the Customer Portal.

How can I retrieve more than 100 items in a single API response?

By default, FinFeedAPI limits responses to 100 items per request. However, you can increase this by using the limit query parameter.

  • The maximum value for limit is 100,000 items
  • If you request more than 100 items, every 100 items counts as one request toward your usage quota

Example:

bash

GET /v1/trades?limit=500

This call will return up to 500 trades and count as 5 requests in your quota.

Use this option when you need to retrieve large result sets efficiently, but be mindful of your daily request limits.

I barely use the REST API. Why is my usage still so high?

REST API usage is measured not by the number of API calls alone, but by request credits, which depend on how much data each call retrieves.

Key points to understand:

  • FinFeedAPI uses a rolling 24-hour window to calculate usage
  • Each data request credit counts as one "request"
  • Some API endpoints return multiple data points per call
  • If the limit parameter is used, every 100 items returned counts as one request credit

Example:

If you make a single call to retrieve 10,000 OHLCV records using limit=10000, that counts as 100 requests (10,000 ÷ 100), not just 1.

So, while your logs may show only 85 API calls in a day, your total usage could reflect over 10,000 request credits—especially when pulling large data batches.

This can lead to exceeding the daily request quotand result in HTTP 429 Too Many Requests errors.

How do I calculate the number of requests I’ll be making for a specific query?

FinFeedAPI uses a credit-based system for REST API requests. The number of request credits consumed depends on how many data items you retrieve in a single call.

How it works:

  • If you do not use the limit parameter, the default is limit=100, which counts as 1 request
  • If you do use the limit parameter, every 100 data items returned counts as 1 request

Example:

bash

GET /v1/ohlcv/BINANCE_SPOT_BTC_USDT/history?limit=1500

This call returns 1,500 items, which counts as 1500 ÷ 100 = 15 requests

Additional tips:

  • limit minimum: 1
  • limit maximum: 100,000
Why does using limit=1 still count as 1 full request in my API usage? Isn't pricing based on 100 data points?

Yes, FinFeedAPI uses a credit-based model, but here's how the request-based billing works with the limit parameter:

How Credit Consumption Works:

  • Each successful API request counts as at least 1 request.
  • If your request includes the limit parameter:
    • Every 100 data points = 1 credit (rounded up).
    • Example: limit=200 = 2 credits, limit=1 = still 1 credit.

Even if you only request 1 data point (limit=1), it still triggers a full request and uses 1 credit, because that's the minimum unit for billing.

Billing, payment & subscriptions
Can I cancel my subscription anytime?

Yes, as stated on our legal terms under Customer Agreement section 2.4:

"You may terminate your initial Order of the applicable Software or Cloud Services under this Agreement, for no reason or any reason, by providing notice of termination. At your request (which may be made through your Account or by contacting us), we may disable the license key that allowed the Software to operate or disable access to the Cloud Services. All fees paid are non-refundable."

More information can be found here

Can I still use my API key if I cancel my subscription?

Cancelling your API key's subscription will render it unusable up until the end of your current billing period. If you still want to be able to use your API key, you may instead opt to downgrade to our Pay As You Go tier.

To learn more about the scope of the Pay As You Go tier, please refer to our Pricing page.

How to reactivate my canceled subscription?

If your subscription was marked for cancelation using the customer portal and your billing period date has not passed, then you can still reactivate it by logging into the Customer Portal and navigating to Subscriptions > Renew Subscription. You will be able to resume the subscription here.

If your subscription was marked for cancelation and your current billing period date has already passed, then you must acquire a new subscription from our Pricing page.

How to subscribe to SEC API?

Subscriptions for the predefined plans are sold through our Pricing page.

Enterprise Plan agreement is custom-tailored to specific project needs. Please contact support or sales to get more information.

How to upgrade/downgrade my subscription?

You may upgrade/downgrade your subscription via the Customer Portal. After logging in, please navigate to Subscriptions > Update Subscription > Select the appropriate subscription that you want to switch to > Continue. We can upgrade or downgrade your subscription as well via a support request.

Upgrading and downgrading operations are prorated; the remaining amount on your subscription at the moment of the change will be credited towards future liabilities. Your billing period cycle is not affected by the plan change.

Example 1:

If you have a Growth subscription with a billing date of 2025-07-15 and on 2025-07-05 and you want to upgrade to the Pro plan, then:

  • Unused Growth subscription between 2025-07-05 and 2025-07-15 will be credited
  • Pro subscription between 2025-07-05 and 2025-07-15 will be debited.

Example 2:

You have a Pro subscription with the billing date 2025-07-15, and on 2025-07-05 you want to downgrade to the Growth plan, then:

  • Unused Pro subscription between 2025-07-05 and 2025-07-15 will be credited
  • Streamer subscription between 2025-07-05 and 2025-07-15 will be debited.
  • The remaining credit will be applied to future invoices

To execute the request, kindly submit a request here.

What do I need to complete a subscription payment?

Purchasing a subscription is straightforward. Here’s what you need to do:

  1. Log in to your account on FinFeedAPI Customer Portal (https://console.coinapi.io/ (https://console.coinapi.io/))
  2. After logging in, visit the Pricing page to choose your desired subscription:
  3. After choosing the subscription, you'll be redirected to a secure Stripe checkout page.
  4. Enter your credit card details and, if applicable, your VAT ID.
  5. Once the payment is completed, your subscription will be activated and you'll receive an invoice.

Important Notes:

  • Please complete your company information in the Billing section before purchasing. This info is used to generate your invoice.
  • VAT ID is required only for companies registered in the EU, except for the UK and Switzerland.

Need help with Stripe or billing? Contact support@finfeedapi.com or reach out through the portal.

Do you accept bank or wire transfers?

Yes, bank and wire transfers are accepted, but only for annual subscriptions.

For monthly subscription plans, payment should be made via credit card through our secure Stripe checkout.

If you're interested in setting up an annual subscription via wire transfer, please contact our support or sales for invoicing assistance.

How should I handle payment errors during sign-up?

When signing up for a FinFeedAPI subscription, you may encounter payment errors returned by our payment processor, Stripe. Common examples include:

  • balance_insufficient – Not enough funds on the card or account
  • card_decline_rate_limit_exceeded – Too many decline attempts
  • email_invalid – The email format is incorrect or unsupported by Stripe

How to resolve:

  1. Refer to Stripe’s official error documentation for guidance:
  2. If the error persists or you're unable to resolve it, please contact FinFeedAPI support team here. We’ll help you investigate and complete your sign-up.
Is there a free tier?

FinFeedAPI does not offer a traditional free plan, but it does provide a Pay-As-You-Go metered plan that includes:

  • $25 in free credits upon signup (generated API Key and verified payment method required)
  • Access to both historical and real-time market data
  • Support for REST and WebSocket protocols
  • Volume-based discounts for higher usage
  • Email support included
  • No monthly commitment — you only pay for what you use

This plan is ideal for developers and small teams who want to test the platform, explore its capabilities, and scale up as needed. Once the $25 credit is exhausted, usage is billed according to the metered pricing.

You can start here: https://www.finfeedapi.com/products/currencies-api/pricing

What happens if I exceed our credit limit? Will I be notified the same day? And how do upgrades work on an annual subscription?

Yes, FinFeedAPI offers proactive monitoring and alerting through its Spend Management System:

  • You can set daily usage thresholds and receive email alerts when they’re exceeded.
  • You can also configure a webhook URL for real-time programmatic notifications.
  • To ensure uninterrupted access, enable Spend Management, which lets you exceed your credit limit at a set daily credit usage budget.

Setup path: Customer Portal > Billing > Spend Management

Upgrading an Annual Subscription

Yes — if you're on an annual plan, you can upgrade at any time:

  • Go to Customer Portal > Subscriptions > Update Subscription
  • This method ensures you're only billed the difference for the remainder of your annual term.

Important: Do not purchase a new plan from the Pricing page — this will create a second, separate subscription rather than upgrading the current one.

Can I customize my plan?

Yes. FinFeedAPI offers customization through the Enterprise plan, which is fully adaptable to your technical, legal, and operational needs.

Custom options include:

  • Dedicated account manager
  • Custom onboarding and SLAs
  • Premium support e.g. a dedicated Slack channel
  • Flexible limits on API usage, request volume, and exchange coverage
  • Tailor-made data delivery (e.g., custom S3 uploads, VPC peering, regional endpoints)

To request a customized plan or explore upgrade options, contact FinFeedAPI support.

How do I pay overdue invoices?

To pay an overdue invoice:

  1. Log in to the Customer Portal
  2. Navigate to the Billing > Invoices section
  3. Select the unpaid invoice and proceed with payment using your saved payment method

If the payment method fails or you encounter issues accessing your account, please contact FinFeedAPI support for assistance.

What is a billing cycle?

FinFeedAPI billing cycle is monthly by default.

  • Monthly plans: You are charged once every month based on your subscription tier.
  • Annual plans: You pay for the entire year upfront, but billing and usage limits are still calculated on a monthly basis (e.g., monthly credit quotas, data caps).

You can view your current billing period, invoice history, and usage metrics in the Customer Portal.

Security and privacy
What CDN does the API use?

We built our own CDN network with nodes directly distributing data between each other via the fastest routes. Any existing CDN solutions are targeted on caching which is not applicable to financial data.

What security mechanisms does FinFeedAPI use to protect my data?

Your sensitive information is stored inside the service provider, which is constantly audited and certified as a PCI-DSS Level 1 Service Provider. This is the most stringent level of certification available in the payments industry. To retain the certification, a payment provider must use world-class security tools and techniques to maintain a high level of security.

What should I do if my API key was compromised?

You may delete the compromised key and generate a new one on the API Keys section of the Customer Portal. This way, the compromised key will no longer be active for use and will not affect your subscription limits.

API access & integration
Where are FinFeedAPI servers located, and how does latency vary by region?

FinFeedAPI operates a globally distributed infrastructure with low-latency data centers in the following locations:

  • AWS Regions: us-east-1, eu-central-1, eu-west-1
  • Colocated Sites:
    • USA: Chicago, New York
    • UK: London
    • Poland: Warsaw
    • Asia: Tokyo

Latency Behavior:

  • Real-time data (via REST /current, WebSocket, FIX) is delivered from the site you’re connected to, routed using GeoDNS to the closest available server.
  • Average latency for public endpoints is ~20ms.
  • On Enterprise plans, customers can achieve sub-1ms latency using direct connections or AWS VPC Peering.

Historical data (via REST /history and Flat Files) is consolidated across all regions to produce a single, globally consistent dataset. This reduces geographic discrepancies but can be impacted by replay process constraints.

Learn more about optimizing connectivity or request direct site access by contacting our support team.

How can I fix certificate validation errors when connecting to FinFeedAPI?

Certificate validation errors typically occur when your system lacks updated CA (Certificate Authority) certificates. Here’s how to resolve it based on your operating system:

On Windows:

  • Ensure your Windows Updates are fully installed, as CA certificates are updated through the standard update process.

On Ubuntu/Debian Linux:

  • Run the following command to refresh your certificate store:

sql
sudo update-ca-certificates

Alternative Option:

If updating certificates isn't feasible, you may connect via an unencrypted HTTP endpoint—though this is not recommended for production due to security concerns.

For production environments, we recommend using HTTPS with properly updated CA bundles.

How can I use FinFeedAPI with MATLAB?

You can integrate CoinAPI with MATLAB using multiple approaches, depending on your preferred development environment:

  1. Java SDK integration: Use Java libraries from MATLAB – Learn how
  2. .NET SDK integration: Call .NET libraries from MATLAB – Guide here
  3. Python SDK integration: Use Python libraries (like FinFeedAPI Python SDK) within MATLAB – Instructions
  4. Use webread() for direct API access: The webread function can call RESTful APIs and automatically convert JSON into MATLAB objects. – See how

This flexibility allows you to access CoinAPI’s market data or exchange rates from within MATLAB for trading strategies, analysis, or research.

What programming languages are supported by FinFeedAPI?

FinFeedAPI is language-agnostic, you can use it with any programming language that supports HTTP requests and JSON parsing.

To make development easier, we provide official SDKs and code examples in our GitHub repository for the following languages:

  • Python
  • R
  • MATLAB
  • C#.NET
  • C++
  • Java
  • Ruby
  • Go
  • JavaScript / TypeScript / Node.js
  • PHP
  • Haskell
  • Objective-C

These SDKs cover common integration patterns for REST, WebSocket, and FIX APIs.

What timezone does FinFeedAPI use for date and time values?

All timestamps returned by FinFeedAPI, across REST, WebSocket, and FIX protocols, are standardized to UTC (Coordinated Universal Time).

This applies to:

  • Historical data (e.g., OHLCV, trades)
  • Real-time streams
  • Metadata and time range filters
Where can I find API examples and SDK source code?

You can explore our official SDKs, integration examples, and client libraries on GitHub.

The repository includes:

  • Sample code for REST, WebSocket, and FIX APIs
  • SDKs in multiple programming languages (e.g., Python, Java, C#, Go, etc.)
  • Tutorials and usage demos

This is the best place to get started with real-world examples and accelerate your integration process.

Can using a VPN affect my connection to FinFeedAPI?

FinFeedAPI does not block or restrict VPN usage, and in most cases, a VPN should not impact your API connection. However, several factors can influence performance:

What to Consider When Using a VPN:

  1. VPN Quality
    • Low-quality VPNs may block API traffic, limit bandwidth, or introduce instability.
  2. Server Location & Latency
    • The physical distance between you, the VPN server, and FinFeedAPI infrastructure can increase latency.
    • In countries with internet restrictions (e.g., China), a VPN may be required to access our services
  3. VPN Configuration
    • Ensure your VPN allows outbound HTTPS traffic and isn’t blocking specific ports or protocols used by FinFeedAPI
  4. Your ISP
    • Even with a VPN, poor underlying internet quality can cause timeouts or dropped connections.

Troubleshooting Tips:

  • Temporarily disable the VPN to check if it’s causing the issue
  • Switch VPN servers or providers for better performance
  • Update your VPN software to the latest version
  • Contact your VPN provider if API traffic is being throttled or blocked

If problems persist, please contact our support team for assistance.

How should I document and troubleshoot FinFeedAPI connectivity issues?

If you're experiencing connection issues with FinFeedAPI please follow the steps below before submitting a support request:

  1. Check FinFeedAPI Status Page to confirm there are no ongoing service disruptions.
  2. Verify DNS resolution Use the dig command to check domain name resolution: A correct response includes an ANSWER SECTION with IP resolution like: If the ANSWER SECTION is missing, this indicates a DNS resolution issue.

pgsql

dig [domain name here]

lua

;; ANSWER SECTION:
fix.coinapi.io. IN CNAME api.coinapi.io.
api.coinapi.io. IN CNAME api.coinapi.net.
...
hdc1-enc-02-bay-08.coinapi.net. IN A 185.204.225.28

  1. Check TCP connectivity Use nc to verify port access: Expected output: If the command fails, analyze the TCP connectivity on your side before contacting support.

cs
nc -v [hostname] -p [port]

css

Connection to fix.coinapi.io 3302 port [tcp/*] succeeded!

  1. Test encryption behavior Try switching between HTTPS and HTTP endpoints. If the issue appears only with one type, document that in your report—it helps isolate encryption-related errors.
  2. Capture a PCAP dump for analysis Use tcpdump to capture traffic. Adjust the port according to the API protocol:
    • REST or WebSocket API:

bash

tcpdump -i [interface] port 80 or port 443 -w dump.$(date +"%Y%m%dT%H%M%S").cap

  • FIX API:

bash

tcpdump -i [interface] port 3302 or port 3303 -w dump.$(date +"%Y%m%dT%H%M%S").cap

  1. Analyze the PCAP file before submission Ensure:
    • CoinAPI is on the other end of the connection
    • The problem is not caused by internal proxies, gateways, or firewall misbehavior
    • The capture was performed from a system directly connected to the internet (not behind NAT if possible)
  2. Submit a support request Use the "API Issues" form at: https://support.coinapi.io/ (https://support.coinapi.io/) Include:
    • Accurate problem description with UTC timestamps
    • Results of the DNS (dig) and TCP (nc) checks
    • A PCAP file with analysis details
    • Set the issue priority according to impact:
      • Urgent – Production system down
      • High – Production system impaired
      • Normal – Feature/system partially affected
      • Low – General guidance or questions

This structured process ensures the support team can respond efficiently and effectively to network-related issues.

Why am I getting an "Invalid API Key" error after generating a new key?

If you're receiving an "Invalid API Key" error shortly after generating a new key, this is expected behavior for a brief period.

FinFeedAPI operates multiple geographically distributed and independent server sites for high availability. Because of this architecture, it may take a few minutes for your new API key to fully propagate across all regions. This short delay is a trade-off for ensuring there is no single point of failure in our infrastructure.

What to do:

  • Wait a few minutes and retry your request
  • Do not regenerate a new key unless the issue persists for more than 5–10 minutes
  • If the problem continues, contact support

How do I generate an API key for FIX API access?

To access FinFeedAPI via FIX protocol, you can use a standard Market Data API key. Here's how to generate it:

How to Generate Your API Key

  1. Log in to your Customer Portal
  2. In the left-side navigation, go to API Keys
  3. Click Create Standard API Keys
  4. Your new API key will be valid for both REST/WebSocket and FIX interfaces

You can also disable or delete keys from the same portal interface as needed.

Why does my WebSocket connection keep disconnecting with code 1006 and no reason?

The WebSocket error code 1006 typically indicates that the connection was closed abnormally, without a proper closing handshake. This can be caused by several external or local factors:

Common Causes:

  • Unstable Internet Connection: Temporary drops or packet loss can trigger disconnections.
  • Firewall or Proxy: Network security layers may block or interrupt persistent WebSocket connections.
  • Client-Side Crashes: Application errors or memory leaks could cause forced shutdowns.
  • Timeouts or Rate Limits: Ensure you’re not exceeding subscription limits or timeouts set by your environment.

Troubleshooting Tips:

  • Ensure a stable and continuous internet connection.
  • Whitelist WebSocket traffic in your firewall or proxy settings.
  • Review your application logs for crashes or timeout issues.
  • Consider implementing reconnection logic in your WebSocket client to handle disconnects gracefully.

If the issue persists and you're on a corporate network, consult your network administrator or reach out to our support team for assistance.