Polygon JVM Client SDK written in Kotlin - WebSocket & RESTful APIs

Welcome to the official JVM client library SDK, written in Kotlin, for the Polygon REST and WebSocket API. This client SDK is usable by any JVM language (including in Android SDK version 21+). To get started, please see the Getting Started section in our documentation, and the docs for code snippets.

Breaking Change Notice

As of July 21, 2025, we've rebuilt client-jvm to be fully generated from the Polygon.io OpenAPI specification.

Key improvements:

• Breaking changes to method names and request/response structures.
• The client is now automatically synchronized with the latest Polygon.io API, ensuring faster access to new endpoints and updates.
• Reduces the risk of SDK/API drift—what you see in the docs is what you get in the client.

Action required:

• If you're upgrading from a previous version, expect incompatibilities—please update your integration accordingly.
• We've updated the docs with usage examples and new patterns for making requests.

Getting started

To access real-time and historical market data with Polygon.io, you will first need to create an account and obtain an API key to authenticate your requests. If you run the samples makes sure to set the POLYGON_API_KEY environment variable for the sample code to use. To persist the environment variable you need to add the above command to the shell startup script (e.g. .bashrc or .bash_profile.

setx POLYGON_API_KEY "<your_api_key>"   # windows
export POLYGON_API_KEY="<your_api_key>" # mac/linux

REST API Client

The REST API provides endpoints that let you query the latest stock, options, indices, forex, and crypto market data market data. You can request data using client methods.

Create the client using your API key.

    ApiClient.apiKey["apiKey"] = "POLYGON_API_KEY"

Get aggregate bars for a stock over a given date range in custom time window sizes.

package org.openapitools.client

import org.openapitools.client.apis.DefaultApi
import org.openapitools.client.apis.DefaultApi.*
import org.openapitools.client.infrastructure.*
import org.openapitools.client.models.*

fun main() {
    ApiClient.apiKey["apiKey"] = "POLYGON_API_KEY"

    val api = DefaultApi()
    try {
        val result = api.GetStocksAggregates(
            multiplier = "1",
            timespan = "day",
            from = "2023-01-09",
            to = "2023-02-10",
            adjusted = "true",
            sort = "asc",
            limit = "120"
        )
        println(result)
    } catch (e: Exception) {
        println("Error calling GetStocksAggregates: ${e.message}")
        e.printStackTrace()
    }
}

Get trades for a ticker symbol in a given time range.

package org.openapitools.client

import org.openapitools.client.apis.DefaultApi
import org.openapitools.client.apis.DefaultApi.*
import org.openapitools.client.infrastructure.*
import org.openapitools.client.models.*

fun main() {
    ApiClient.apiKey["apiKey"] = "POLYGON_API_KEY"

    val api = DefaultApi()
    try {
        val result = api.GetStocksTrades(
            stockTicker = "AAPL",
            order = "asc",
            limit = "10",
            sort = "timestamp"
        )
        println(result)
    } catch (e: Exception) {
        println("Error calling GetStocksTrades: ${e.message}")
        e.printStackTrace()
    }
}

Get a Full Market Snapshot for a all stocks.

package org.openapitools.client

import org.openapitools.client.apis.DefaultApi
import org.openapitools.client.apis.DefaultApi.*
import org.openapitools.client.infrastructure.*
import org.openapitools.client.models.*

fun main() {
    ApiClient.apiKey["apiKey"] = "POLYGON_API_KEY"

    val api = DefaultApi()
    try {
        val result = api.GetStocksSnapshotTickers(
        )
        println(result)
    } catch (e: Exception) {
        println("Error calling GetStocksSnapshotTickers: ${e.message}")
        e.printStackTrace()
    }
}

Please see more detailed code in the docs for code snippets.