Quickstart

Install the Blueticks SDK for your language, authenticate, and make your first call.

Pick your language below. All three SDKs expose the same resources and follow the same naming conventions.

1. Install

pip install blueticks

npm install blueticks

composer require blueticks/blueticks guzzlehttp/guzzle

PHP uses PSR-18 HTTP clients. Install any concrete client (Guzzle shown); the SDK discovers it at runtime.

2. Set your API key

Export your key as an environment variable so the SDK picks it up automatically:

export BLUETICKS_API_KEY=bt_live_...

See Authentication for how to obtain a key.

3. Ping the API

from blueticks import Blueticks

client = Blueticks()
ping = client.ping()
print(ping.account_id, ping.scopes)

import { Blueticks } from "blueticks";

const client = new Blueticks();
const ping = await client.ping();
console.log(ping.account_id, ping.scopes);

<?php
require 'vendor/autoload.php';

use Blueticks\Blueticks;

$client = new Blueticks();
$ping = $client->ping();
echo $ping->account_id, ' ', implode(',', $ping->scopes), "\n";

A successful response looks like:

{
  "account_id": "acct_abc123",
  "key_prefix": "bt_live_xy",
  "scopes": ["messages:read", "messages:write"]
}

4. Retrieve your account

account = client.account.retrieve()
print(account.name, account.timezone)

const account = await client.account.retrieve();
console.log(account.name, account.timezone);

$account = $client->account->retrieve();
echo $account->name, ' ', $account->timezone, "\n";

Next steps

Authentication — key rotation, environments.
Errors & retries — how to handle transient failures.
API Reference — every endpoint with an interactive playground.