Roku

Roku Input API

Custom input event injection

Documentation GitHub OpenAPI

Documentation

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

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

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

https://developer.roku.com/dev/docs/roku-web-service

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

Specifications

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/openapi/roku-input-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/external-control-protocol-active-app-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/external-control-protocol-app-list-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/external-control-protocol-app-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/external-control-protocol-device-info-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/external-control-protocol-media-player-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/external-control-protocol-device-info-structure.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/external-control-protocol-app-structure.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/external-control-protocol-app-list-structure.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/external-control-protocol-active-app-structure.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/external-control-protocol-media-player-structure.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/pay-web-services-transaction-validation-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/pay-web-services-refund-validation-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/pay-web-services-cancel-subscription-request-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/pay-web-services-refund-subscription-request-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/pay-web-services-update-bill-cycle-request-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/pay-web-services-issue-credit-request-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/pay-web-services-subscription-result-schema.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/pay-web-services-transaction-validation-structure.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/pay-web-services-refund-validation-structure.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/pay-web-services-subscription-result-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-ld/roku-external-control-protocol-context.jsonld

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/examples/external-control-protocol-query-device-info-example.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/examples/external-control-protocol-query-apps-example.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/examples/external-control-protocol-launch-app-example.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-ld/roku-pay-web-services-context.jsonld

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/examples/pay-web-services-validate-transaction-example.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/examples/pay-web-services-cancel-subscription-example.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-ld/roku-nabu-cloud-context.jsonld

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/examples/nabu-cloud-list-devices-example.json

https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/examples/nabu-cloud-create-device-example.json

OpenAPI Specification

openapi: 3.0.3
info:
  title: Roku External Control Protocol (ECP) Apps Input API
  version: '1.0'
  description: 'The External Control Protocol (ECP) is an HTTP-based API exposed on port 8060 of every Roku

    streaming device on the local network. It enables third-party applications, mobile remote-control

    apps, automated testing systems, and home-automation hubs to discover Roku devices via SSDP,

    inject simulated remote-control key presses, launch installed apps with deep-link parameters,

    query device state, and retrieve diagnostic information.


    The protocol is plain HTTP/1.1 (no TLS) and is intended for trusted local-network use only.

    Most control operations require the user to enable "Control by mobile apps" on the device.

    Additional diagnostic endpoints (chanperf, sgnodes, registry, etc.) are gated behind Roku

    Developer Mode.

    '
  contact:
    name: Roku Developer Program
    url: https://developer.roku.com
  x-generated-from: documentation
  x-source-url: https://developer.roku.com/docs/developer-program/dev-tools/external-control-api.md
servers:
- url: http://{rokuDeviceIp}:8060
  description: A Roku device on the local network
  variables:
    rokuDeviceIp:
      default: 192.168.1.100
      description: The IPv4 address of the Roku device, discovered via SSDP
tags:
- name: Input
  description: Custom input event injection
paths:
  /input:
    post:
      operationId: sendInput
      summary: Roku Send Input Event
      description: Sends a custom input event (key/value query parameters) to the active channel via the `roInput` SceneGraph node. Used for deep-linking, sensor data, and external control integrations.
      tags:
      - Input
      responses:
        '200':
          description: Input event delivered
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK