Test Streaming

Home Resources

Test your streaming implementation against a mock-up service which mirrors the official Companies House Streaming API behaviour and supports fault injection for testing reconnection logic.
Create a temporary API key for your session, and use the test service base URL.

Create or resume

Start a new session, or paste an existing test key to open its dashboard.

Existing test key

Implementation checklist

Every production implementation that connects to the streaming API should account for these.

Authenticate requests with HTTP Basic Auth, ie Authorization: Basic {base64(apiKey+':')}
Re-connect when disconnected, using last received timepoint + 1
Handle 416 response code for timepoint out of range (usually drop the timepoint param)
Split HTTP response stream by newlines without waiting for full response
Max of 9 concurrent connections per API key
Handle 429 response for too many connections in quick succession
Handle 5xx responses. They're common. Just retry after a few minutes.

Test Streaming

Create or resume

Session dashboard

API key

Base URL

Stream paths

Active connections

Connection logs

Implementation checklist