Welcome to APICalls.io – Your Guide to Getting Started

We are thrilled to have you onboard at APICalls.io! Our platform empowers developers, analysts, and traders with access to robust financial and market data through our comprehensive API. This guide is designed to help you navigate and fully utilize the API documentation, ensuring that you can quickly integrate market data into your applications with ease. Whether you are retrieving stock quotes, options activity, or technical indicators, we’ve got you covered.

Base URL

All of our API requests should be sent to the following base URL:

https://api.apicalls.io

Navigating the Documentation

As you explore our documentation, you’ll find endpoint details, parameters, and code examples in different programming languages. The interface is designed to allow you to switch between languages (e.g., Python, JavaScript) for better integration into your preferred development environment. On mobile, you can access these options from the navigation menu at the top.

Authenticating Requests

Every request to our API requires proper authentication. Here's how you can authenticate:

1. Authorization Header: Use an Authorization header with the value Bearer {YOUR_AUTH_KEY}. Example: 
   curl -X GET "https://api.apicalls.io/v1/markets/search?search=AA" -H "Authorization: Bearer YOUR_AUTH_KEY"
2. API Key Parameter: You can also pass the apikey parameter in the URL query. Example: https://api.apicalls.io/v1/markets/search?search=AA&apikey={YOUR_API_KEY}

You can generate your API token by visiting your dashboard. In the upper-right corner, navigate to your account and click Personal Access Tokens in the dropdown to generate or manage your tokens.

Rate Limiting

To ensure optimal performance for all users, APICalls.io employs rate limiting. Please refer to our API documentation for the current request per second. Should you exceed this rate, you will receive a 429 Too Many Requests response. We recommend using a retry mechanism in your code to handle these responses smoothly.

Overview of Stocks & Options Endpoints

Our API is designed to provide you with a wide range of market data, from stock prices and financial summaries to options activity and technical indicators. Let’s take a closer look at the key endpoints available to you.

# General Endpoints

• Search Stocks: Retrieve stock information based on symbols or names.

  • GET /v1/search: Perform a general stock search.
  • GET /v2/search: Advanced stock search for improved results.

• News: Stay updated with the latest financial news.

  • GET /v1/news: General news.
  • GET /v2/news: Trending and top market news.

• Screeners: Filter stocks based on financial or technical criteria.

  • GET /v1/screener: General screener.
  • GET /v2/screener trending: Popular stocks based on screener results.

• Insider Trades: Get insights into insider buying or selling activity.

  • GET /v1/insider-trades: Access detailed information on recent insider trades.

# Stock-Specific Endpoints

• Real-Time Quotes: Get up-to-the-second stock prices.

  • GET /v1/quote: Fetch the latest real-time quote.
  • GET /v1/quotes: Retrieve multiple stock quotes.

• Historical Data: Access historical prices to analyze trends over time.

  • GET /v1/history: Request daily or intraday historical prices.

• Financial Data & Ratings: Stay informed about company performance and analyst predictions.

  • GET /v1/analyst-ratings: View analyst ratings for stocks.
  • GET /v2/ticker-summary: Detailed financial summaries for stocks.
  • GET /v2/financials: Company financials (income statements, balance sheets).
  • GET /v2/price-targets: Analyst price targets for stocks.
  • GET /v2/short-interest: Short interest data for stocks.
  • GET /v2/institutional-holdings: Information on institutional ownership.
  • GET /v2/sec-filings: Access a company’s SEC filings.

• Advanced Market Data:

  • GET /v2/revenue: Access revenue data for companies.
  • GET /v2/historical: Deep dive into historical financial data.

# Options Endpoints

Our options endpoints offer powerful insights into market volatility and trading activity. Whether you are a professional trader or simply exploring options data, these endpoints are designed to give you the information you need.

• Options Data: General options information and pricing.

  • GET /v1/options: Retrieve general options data.
  • GET /v1/unusual-options-activity: Identify unusual or large trades.
  • GET /v1/iv-rank-percentile: Implied volatility rankings.

• Options Activity:

  • GET /v1/most-active: Discover the most actively traded options.
  • GET /v1/options-flow: Track options flow data.
  • GET /v2/options: Trending options activity.

# Calendar Events

• Earnings Data:

  • GET /v1/earnings: Get upcoming earnings reports.
  • GET /v1/dividends: Stay on top of dividend announcements.

• Economic Events:

  • GET /v1/economic_events: Track key economic events and their impact.
  • GET /v1/ipo: List of upcoming initial public offerings (IPOs).
  • GET /v1/public_offerings: Track public offering events.

# Technical Indicators

Our API supports a wide array of technical indicators for market analysis, perfect for traders relying on algorithmic trading strategies or technical studies.

• Moving Averages:

  • GET /v1/indicators/sma: Simple Moving Average.
  • GET /v1/indicators/ema: Exponential Moving Average.

• Momentum Indicators:

  • GET /v1/indicators/rsi: Relative Strength Index (RSI).
  • GET /v1/indicators/macd: Moving Average Convergence Divergence (MACD).
  • GET /v1/indicators/stoch: Stochastic Oscillator.

• Volume Indicators:

  • GET /v1/indicators/adosc: Accumulation/Distribution Oscillator.

Best Practices for Integration

• Optimize for Rate Limits: Keep track of the rate limits in your application, and implement efficient retry logic to handle API throttling.
• Cache Results: For data that doesn’t change frequently, consider caching results to reduce unnecessary API calls.
• Error Handling: Use proper error handling to manage 4xx and 5xx HTTP responses gracefully in your application.

Conclusion

We hope this guide helps you get started with our API quickly and efficiently. Our extensive documentation provides everything you need to fetch real-time market data, perform detailed stock analyses, and integrate financial information into your applications. Happy coding!

For further questions or support, please feel free to reach out via our support channels.

Welcome aboard, and we look forward to seeing what you build!