MarketStack Wrapper

marketstack_wrapper is a Ruby gem that provides a simple interface for accessing the MarketStack API. The API offers stock market data including tickers, historical data, intraday data, and more.

• Fetch all available tickers

• Retrieve data for a specific ticker

• Access end-of-day (EOD) or intraday stock prices

• Fetch historical data for single or multiple tickers

• Pagination support for large datasets

Add the gem to your Gemfile:

gem 'marketstack_wrapper'

Then, run:

bundle install

Alternatively, install it directly:

gem install marketstack_wrapper

To use the gem, you need an API key from MarketStack. Sign up for a free or paid plan to get your access_key.

Here’s how you can use the gem to interact with the MarketStack API:

require 'marketstack_wrapper'

# Initialize the client with your API key
client = MarketstackWrapper::Client.new('your_access_key')

tickers = client.get_all_tickers(limit: 10, offset: 0)
puts tickers

ticker = client.get_ticker('AAPL')
puts ticker

eod_data = client.get_ticker_eod('AAPL', limit: 5)
puts eod_data

intraday_data = client.get_ticker_intraday('AAPL', limit: 5)
puts intraday_data

latest_intraday = client.get_ticker_latest_intraday('AAPL')
puts latest_intraday

latest_eod = client.get_ticker_latest_eod('AAPL')
puts latest_eod

historical_data = client.get_historical_data(symbol: 'AAPL', date_from: '2023-01-01', date_to: '2023-02-01', limit: 10)
puts historical_data

multi_historical = client.get_multiple_historical_data(symbols: ['AAPL', 'GOOG', 'MSFT'], date_from: '2023-01-01', date_to: '2023-02-01', limit: 10)
puts multi_historical

All endpoints support pagination with limit and offset parameters. Adjust these to retrieve more results when necessary.

The gem raises exceptions if the API response indicates an error (e.g., invalid API key, rate limit exceeded). Make sure to handle these exceptions in your code:

begin
  tickers = client.get_all_tickers
rescue => e
  puts "An error occurred: #{e.message}"
end

Contributions are welcome! To get started with development:

1. Clone the repository

git clone https://github.com/yourusername/marketstack\_wrapper.gitcd marketstack\_wrapper

2. Install the dependencies

bundle install

3. Run tests

rspec

1. Fork the repository.

2. Create a new feature branch

git checkout -b my-feature-branch

3. Commit your changes:

git commit -m "Add my new feature"

4. Push to your branch:

git push origin my-feature-branch

5. Open a pull request on GitHub.

This project is licensed under the MIT License. See the LICENSE file for details.