Developer Documentation

Everything you need to integrate SRGSSR APIs — from authentication to production deployment.

Core Concepts

Authentication

All SRGSSR APIs use OAuth 2.0 client credentials. Include your client_id and client_secret to obtain a bearer token, then pass it in the Authorization: Bearer <token> header on every request.

POST /oauth2/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=YOUR_CLIENT_ID
&client_secret=YOUR_CLIENT_SECRET

Base URLs

Each API has its own versioned base URL. Always use the latest stable version unless you have a specific reason to pin to an older release.

# Address Validation v5
https://api.srgssr.com/address/v5

# Network Intelligence v6
https://api.srgssr.com/network/v6

# Availability v5
https://api.srgssr.com/availability/v5

Rate Limits

Rate limits vary by plan. Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers so you can track usage in real time.

HTTP/1.1 200 OK
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1711220400

Error Codes

All errors return a consistent JSON envelope with a code, message, and optional details array. HTTP status codes follow REST conventions (4xx for client errors, 5xx for server errors).

{
  "code": "INVALID_ADDRESS",
  "message": "The address could not be parsed.",
  "details": [
    { "field": "zip", "issue": "Invalid format" }
  ]
}

SDKs & Client Libraries

Official and community-maintained libraries for every major language.

🟨

JavaScript / Node

Official
npm install @srgssr/sdk
🐍

Python

Official
pip install srgssr-sdk

Java

Official
implementation "com.srgssr:sdk:2.0"
🐹

Go

Official
go get github.com/srgssr/sdk-go
🐘

PHP

Community
composer require srgssr/sdk
💎

Ruby

Community
gem install srgssr-sdk

Can't find what you need?

Our developer support team is here to help.