Platform API

ably · Company

Company No Auth Free & Open cloud

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Enumerate all active channels of the application

Enumerate all active channels of the application

https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/channels?by=value&limit=100&format=json&prefix=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/channels?by=value&limit=100&format=json&prefix=example"

import requests
params = {
    "by": "value",
    "limit": "100",
    "format": "json",
    "prefix": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/channels",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/channels');
url.searchParams.set('by', 'value');
url.searchParams.set('limit', '100');
url.searchParams.set('format', 'json');
url.searchParams.set('prefix', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/channels")
	q := baseURL.Query()
	q.Set("by", "value")
	q.Set("limit", "100")
	q.Set("format", "json")
	q.Set("prefix", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/channels")
uri.query = URI.encode_www_form({
  "by" => "value",
  "limit" => "100",
  "format" => "json",
  "prefix" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/channels?" . http_build_query([
    "by" => "value",
    "limit" => "100",
    "format" => "json",
    "prefix" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve usage statistics for an application

The Ably system can be queried to obtain usage statistics for a given application, and results are provided aggregated across all channels in use in the application in the specified period. Stats may be used to track usage against account quotas.

https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/stats?end=now&unit=minute&limit=100&start=example&format=json&direction=backwards

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/stats?end=now&unit=minute&limit=100&start=example&format=json&direction=backwards"

import requests
params = {
    "end": "now",
    "unit": "minute",
    "limit": "100",
    "start": "example",
    "format": "json",
    "direction": "backwards"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/stats",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/stats');
url.searchParams.set('end', 'now');
url.searchParams.set('unit', 'minute');
url.searchParams.set('limit', '100');
url.searchParams.set('start', 'example');
url.searchParams.set('format', 'json');
url.searchParams.set('direction', 'backwards');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/stats")
	q := baseURL.Query()
	q.Set("end", "now")
	q.Set("unit", "minute")
	q.Set("limit", "100")
	q.Set("start", "example")
	q.Set("format", "json")
	q.Set("direction", "backwards")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/stats")
uri.query = URI.encode_www_form({
  "end" => "now",
  "unit" => "minute",
  "limit" => "100",
  "start" => "example",
  "format" => "json",
  "direction" => "backwards"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/stats?" . http_build_query([
    "end" => "now",
    "unit" => "minute",
    "limit" => "100",
    "start" => "example",
    "format" => "json",
    "direction" => "backwards"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List channel subscriptions

Get a list of push notification subscriptions to channels.

https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/push/channelSubscriptions?limit=100&format=json&channel=example&clientId=example&deviceId=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/push/channelSubscriptions?limit=100&format=json&channel=example&clientId=example&deviceId=example"

import requests
params = {
    "limit": "100",
    "format": "json",
    "channel": "example",
    "clientId": "example",
    "deviceId": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/push/channelSubscriptions",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/push/channelSubscriptions');
url.searchParams.set('limit', '100');
url.searchParams.set('format', 'json');
url.searchParams.set('channel', 'example');
url.searchParams.set('clientId', 'example');
url.searchParams.set('deviceId', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/push/channelSubscriptions")
	q := baseURL.Query()
	q.Set("limit", "100")
	q.Set("format", "json")
	q.Set("channel", "example")
	q.Set("clientId", "example")
	q.Set("deviceId", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/push/channelSubscriptions")
uri.query = URI.encode_www_form({
  "limit" => "100",
  "format" => "json",
  "channel" => "example",
  "clientId" => "example",
  "deviceId" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/push/channelSubscriptions?" . http_build_query([
    "limit" => "100",
    "format" => "json",
    "channel" => "example",
    "clientId" => "example",
    "deviceId" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Platform API?

Platform API is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Platform API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗