Skip to content

api-evangelist/roku

BranchesTags

Repository files navigation

Roku (roku)

Roku is the leading TV streaming platform in the U.S., Canada, and Mexico, offering a comprehensive operating system that powers smart TVs, streaming players, and audio devices. Roku provides a robust developer program for building channel apps, monetizing through Roku Pay, integrating analytics, and controlling devices via the External Control Protocol. The platform supports both BrightScript and SceneGraph frameworks for app development, and the Nabu Cloud developer cloud for managing remote test devices and channel builds.

URL: Visit APIs.json URL

Run: Capabilities Using Naftiko

Tags:

  • Streaming, Television, Media, Entertainment, Connected TV, Consumer Electronics

Timestamps

  • Created: 2026-05-04
  • Modified: 2026-05-05

APIs

Roku BrightScript SDK

BrightScript is Roku's scripting language used to build apps for the Roku platform. The SDK provides a comprehensive component library with over 100 built-in objects covering UI, networking, media playback, and device interaction. BrightScript is a programming language and on-device runtime, not a network API.

Human URL: https://developer.roku.com/docs/references/brightscript/component-reference.md

Tags:

  • SDK, BrightScript, Channel Development

Properties

Roku SceneGraph

SceneGraph is Roku's XML-based declarative UI framework for building rich, performant channel applications. It provides node components, animations, and a scene-based architecture. SceneGraph is an on-device UI framework, not a network API.

Human URL: https://developer.roku.com/docs/developer-program/core-concepts/scenegraph-overview.md

Tags:

  • UI Framework, SceneGraph, Channel Development

Properties

Roku External Control Protocol (ECP)

The External Control Protocol (ECP) is an HTTP-based API exposed on port 8060 of every Roku device on the local network. It enables third-party applications, mobile remote-control apps, automated test systems, and home-automation hubs to discover devices via SSDP, inject simulated remote-control key presses, launch installed apps with deep-link parameters, query device state, and retrieve developer-mode diagnostics.

Human URL: https://developer.roku.com/docs/developer-program/dev-tools/external-control-api.md

Tags:

  • REST, HTTP, Device Control, LAN

Properties

Roku Pay Web Services

Roku Pay Web Services provide server-to-server APIs for billing, subscription management, transaction validation, and entitlement checks for monetized Roku channels. Channels query these endpoints from their authentication backends to verify entitlements, issue refunds, adjust billing cycles, and grant service credits.

Human URL: https://developer.roku.com/docs/developer-program/roku-pay/overview.md

Tags:

  • Billing, Payments, Subscriptions, Monetization

Properties

Roku Nabu Cloud

Nabu Cloud is Roku's developer cloud platform for managing remote test devices, snapshots, builds, projects, organisations, groups, and personal access tokens. It provides REST APIs (and an AsyncAPI streaming endpoint) for orchestrating remote Roku test devices and CI/CD workflows. The OpenAPI specification is published in the Roku dev-doc repository.

Human URL: https://github.com/rokudev/dev-doc/tree/v2.0/reference/nabu_cloud

Tags:

  • REST, Developer Cloud, Test Devices, CI CD

Properties

Roku Search Feed

Roku Search Feed is a JSON feed format that publishers ingest to expose their catalog to Roku Search. The feed provides movies, series, episodes, short-form videos, TV specials, and live feeds with localized titles, descriptions, ratings, content links, and external IDs.

Human URL: https://github.com/rokudev/search-feed-json

Tags:

  • Feed, Search, Content Catalog

Properties

Roku Direct Publisher Feed

Roku Direct Publisher (RDP) feed is a JSON feed specification that allows non-technical publishers to populate channels by hosting a structured catalog of short-form videos, movies, series, episodes, and live feeds. Roku ingests the feed on a schedule and renders the channel UI automatically.

Human URL: https://github.com/rokudev/feed-specifications

Tags:

  • Feed, Direct Publisher, Content Catalog

Properties

Roku Analytics

Roku Analytics provides performance reporting, audience metrics, and engagement data for Roku channel publishers. Reports are accessed through the Roku Developer Dashboard rather than a public REST API.

Human URL: https://developer.roku.com/docs/developer-program/marketing/roku-analytics.md

Tags:

  • Analytics, Reporting

Properties

Roku Authentication Framework

APIs and patterns for implementing user sign-in and authentication within Roku channels, including device-linking ("on-device authentication") and OAuth-style flows. The framework is implemented in BrightScript on the device; the publisher's authentication backend is custom-built.

Human URL: https://developer.roku.com/docs/developer-program/authentication/authentication-overview.md

Tags:

  • Authentication, OAuth

Properties

Common Properties

Features

Name Description
Channel Development BrightScript and SceneGraph frameworks for building Roku TV streaming channel applications.
Device Control Local-network HTTP API (ECP) for discovery, key injection, app launching, and diagnostics.
Roku Pay Server-to-server billing APIs for transaction validation, refunds, and subscription management.
Direct Publisher JSON feed ingestion path for non-technical publishers to populate Roku channels.
Search Feed Catalog feed ingestion that surfaces publisher content in Roku Search.
Nabu Cloud Roku's developer cloud for managing remote test devices, snapshots, and builds.
Channel Store Monetization Transactional and subscription monetization through ChannelStore and roChannelStore components.
Advertising Framework Roku Advertising Framework (RAF) for monetizing video content with ads.

Use Cases

Name Description
Streaming Channel Development Build full-screen TV streaming channels with BrightScript/SceneGraph and ship to the Roku Channel Store.
Subscription Video On Demand Monetize video content with recurring subscriptions managed by Roku Pay.
Transactional Video On Demand Monetize individual movie/episode purchases via the Channel Store and Roku Pay.
Free Ad-Supported Streaming TV Free streaming with the Roku Advertising Framework.
TV Remote and Home Automation Build mobile or hub-based remote-control apps that drive Roku devices via ECP.
Automated Channel Testing Run channel certification tests on remote Roku test devices in Nabu Cloud.

Integrations

Name Description
Visual Studio Code BrightScript language extension for VSCode with debugging and side-loading.
Selenium WebDriver WebDriver-based automated channel testing.
npm roku-deploy and roku-debug published as npm packages.
Sublime Text BrightScript syntax-highlighting package.
GitHub Source-of-truth for Roku-published samples, tooling, and the dev-doc OpenAPI spec.

Artifacts

Machine-readable API specifications organized by format.

OpenAPI

JSON Schema

JSON Structure

JSON-LD

Examples

Capabilities

Naftiko capabilities organized as shared per-API definitions composed into customer-facing workflows.

Shared Per-API Definitions

Workflow Capabilities

Workflow APIs Combined Tools Persona
Roku Channel Operations ECP, Pay, Nabu Cloud 21 Channel Developer, QA Engineer, Billing Operator

Vocabulary

  • Roku Vocabulary — Unified taxonomy mapping 17 resources, 15 actions, 1 workflow, and 3 personas across operational (OpenAPI) and capability (Naftiko) dimensions

Rules

Maintainers

FN: API Evangelist

URL: https://apievangelist.com

About

Roku is the leading TV streaming platform in the U.S., Canada, and Mexico, offering a comprehensive operating system that powers smart TVs, streaming players, and audio devices.

Topics

streaming media television entertainment connected-tv apis-json consumer-electronics naftiko

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors