# TikTok WSS X-Bogus Signature API

> Generates the X-Bogus signature required for TikTok WebSocket connections. Accepts an optional custom browser user-agent string.

Source: https://www.sandbase.ai/apis/tiktok/web/generate-wss-xb-signature
API reference: https://www.sandbase.ai/apis/tiktok/web/generate-wss-xb-signature/docs

## Facts

- Provider: TikTok
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/tiktok/web/generate-wss-xb-signature`
- Price: $0.0015 per call
- Free allowance: 100 calls per organization per UTC day, shared across eligible APIs
- Capabilities: api, tiktok
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/tiktok/web/generate-wss-xb-signature` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `user_agent` | string | no |  |

## FAQ

### How do I use the TikTok WSS X-Bogus Signature API?

Send a POST request to https://api.sandbase.ai/v1/api/tiktok/web/generate-wss-xb-signature with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the TikTok WSS X-Bogus Signature API cost?

$0.0015 per call. Every organization gets 100 free calls per UTC day, shared across eligible SandBase APIs including this one; after that each call is billed at this price from your SandBase balance. There is no subscription.

### What parameters does the TikTok WSS X-Bogus Signature API accept?

No parameters are required. Optional: user_agent (string). The Parameters table and the Playground on this page list every field.

### What does the TikTok WSS X-Bogus Signature API return?

A JSON response returned in the same HTTP request (synchronous).

### Do I need a TikTok developer account or API key?

No. TikTok WSS X-Bogus Signature runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for TikTok API access separately.

## README

### TikTok WSS X-Bogus Signature API

Retrieve an X-Bogus signature needed for TikTok WSS connections. You can optionally supply `user_agent` to match a specific client environment.

#### Use cases

- Establish real-time TikTok WebSocket connections requiring signature verification.
- Provide custom user agent strings to match client request headers.
- Authenticate automated listeners for TikTok web stream events.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/api/tiktok/web/generate-wss-xb-signature" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `user_agent` | string | No | User browser agent (optional, uses default UA if not provided) |

#### Notes

- Uses a default user agent string if `user_agent` is omitted.

#### Related APIs

- [TikTok Video IDs from URLs (Batch)](/model/tiktok/web/all-aweme-id): Resolves and extracts TikTok video IDs from a list of video URLs.
- [TikTok User Sec User ID Extractor](/model/tiktok/web/all-sec-user-id): Returns a list of sec_user_id identifiers corresponding to TikTok user profile URLs.
- [TikTok Profile Unique IDs](/model/tiktok/web/all-unique-id): Resolves a batch of TikTok user homepage links to retrieve their corresponding unique identifiers.