Documentation Status Discord Build Status Code Style: Black

This library is a reimplementation and subset of json_stream. It enables reading JSON data from a stream rather that loading it all into memory at once. The interface works like lists and dictionaries that are usually returned from json.load() but require in-order access. Out of order accesses will lead to missing keys and list entries.


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

This library is on PyPI for editors that use it for CircuitPython. In CPython, it is recommended to use json_stream itself.

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_json_stream

Or the following command to update an existing version:

circup update

Usage Example

import ssl
import time
import adafruit_requests
import socketpool
import wifi
import adafruit_json_stream as json_stream

pool = socketpool.SocketPool(
session = adafruit_requests.Session(pool, ssl.create_default_context())


while True:
    resp = session.get(SCORE_URL)
    json_data = json_stream.load(resp.iter_content(32))
    for event in json_data["events"]:
        if "Seattle" not in event["name"]:
        for competition in event["competitions"]:
            for competitor in competition["competitors"]:
                print(competitor["team"]["displayName"], competitor["score"])


API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Table of Contents

Indices and tables