How to Get Started with S3 on

Oct 20, 2023
Updated: Nov 02, 2023 is proud to offer extensive financial datasets, easily accessible thanks to S3. This guide provides detailed steps on setting up various S3 clients to efficiently retrieve the data you need.


A valid flat files subscription with, after which you will receive unique authentication keys. We have standardized the endpoint and bucket details for all users as follows:

Endpoint: Bucket: flatfiles

Supported S3 Clients rigorously tests and supports four widely recognized S3 clients to ensure compatibility and user convenience. These include:

  1. AWS S3 CLI
  2. Rclone
  3. MinIO
  4. Python Boto3 SDK

Below, you’ll find the setup process for each client.


The AWS S3 Command Line Interface (CLI) is a powerful tool designed to interact with Amazon S3.

Here’s how to get started:

  • Install the AWS S3 CLI from the official website.
  • Run aws configure in your command line and enter your Access Key ID, Secret Access Key, and default region when prompted.
  • To interact with's S3 files, use the following structured command:
aws s3 ls s3://flatfiles/ --endpoint-url


Rclone facilitates data synchronization between your local system and S3 storage. Follow these steps to configure Rclone with

  • Download and install Rclone from here.
  • Initiate a new remote storage configuration with rclone config.
  • Here's an example configuration is provided below for reference:
type = s3
env_auth = false
access_key_id = [ACCESS_KEY_ID]
secret_access_key = [SECRET_ACCESS_KEY]
endpoint =

d. After configuration, you can interact with your storage using commands like rclone ls s3:flatfiles.


MinIO client works seamlessly with any S3 compatible cloud storage. Here’s how to configure it with

  • If you haven't already, download and set up MinIO from their documentation.
  • Modify your .mc/config.json file with the configuration shown below:
           "version": "10",
           "aliases": {
                   "s3": {
                           "url": "",
                           "accessKey": "YourAccessKey",
                           "secretKey": "YourSecretKey",
                           "api": "S3v4",
                           "path": "auto"
  • Your client is now ready for use with commands specific to MinIO.

Python Boto3 SDK

Boto3 is the Amazon Web Services (AWS) SDK for Python, which enables Python developers to write software that makes use of Amazon services like S3. To set it up, follow these steps:

  • Install Boto3 by running pip install boto3 if you haven't already.
  • Utilize the following script to interact with data:
   import boto3
   from botocore.client import Config

   # Initialize a session using your credentials
   session = boto3.Session(

   # Create a client with your session and specify the endpoint
   s3 = session.client(

   # List buckets, objects, or perform any other operations
   for key in s3.list_objects(Bucket='flatfiles')['Contents']:

c. This script initiates a session with your credentials, establishes a client connection, and lists all files available in the specified bucket.

Next Steps

By following the steps outlined for each client, you can efficiently set up your systems to access extensive financial datasets from via S3. or further assistance or more advanced setup options, please refer to the respective client’s official documentation.

Was this helpful?
Help us improve

Still have questions?

Get in touch with our team

cta icon

Newsletter Sign Up

Submit your email below and get notified via our email newsletter
cta image
cta icon
Public Slack

Join us on Slack

Submit your email below for an invite to the slack community
cta image
cta icon
Public GitHub

Find us on GitHub

Join an active community of developers contributing to
Find us on GitHub
cta image
All data provided on Polygon is provided for informational purposes only, and is not intended for trading or investing purposes. Polygon provides all information as is. You must not redistribute information displayed on or provided by Polygon. Stock prices displayed in the ticker are from a subset of exchanges, this price does not represent the real-time price from the SIP.

©, Inc