Create Watchlist
This API allows a user to create a new Watchlist. A watchlist can contain a set of scrips (instruments), and users can specify privacy and default settings. The response returns the created watchlist details.
🔑Header Parameters
| Header | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| Authorization | string | Yes | Bearer token for user authentication | Bearer access_token |
| x-api-key | string | Yes | API key for access control | x-api-key |
🧾Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| sWatchListName | string | Yes | Name of the Watchlist | "Energy Sector" |
| bIsPrivate | boolean | No | Flag to mark Watchlist as private | true (private), false (public) |
| bIsDefault | boolean | No | Flag to make this the default Watchlist | true / false |
| sSettings | string | No | Reserved JSON string for settings | "" |
| scrips | array | Yes | List of scrips to include in the Watchlist | See Scrip Object below |
📑Scrip Object Fields
| Field | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| nMarketSegmentId | number | Yes | Exchange segment ID | 1 |
| nToken | number | Yes | Unique token number for the scrip/instrument | 123456 |
| nSequenceNo | number | Yes | Sequence of the scrip in the Watchlist | 1, 2, ... |
| sSettings | string | No | Reserved for future settings (JSON string) | "" |
🟢Success Response - 200 Ok
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| status | string | Status of the API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Descriptive success message | "Watchlist Created successfully" |
| data | array of object | List of Watchlist objects | See details below |
🧭Watchlist Object Schema
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| id | string | Unique Watchlist ID | "32b95c61-370-b215-bb8857f9c949" |
| sWatchListName | string | Name of the Watchlist | "Watchlist 1" |
| bIsPrivate | boolean | If true, watchlist is private | true |
| bIsDefault | boolean | If true, this is the default watchlist | false |
| sUserId | string | User ID of the watchlist creator | "user123" |
| sTenantId | string | Tenant/Broker ID | "1256878" |
| sSettings | string | Reserved for future (must be valid JSON string) | {"subCount":13} |
| scrips | array | List of scrips within the watchlist | See Scrip Object above |
| _version | number | Version number of the watchlist | 1 |
| _deleted | boolean | Flag to indicate if deleted | false |
| _lastChangedAt | number | Epoch timestamp of last change | 1718008123 |
| createdAt | string | ISO date-time of watchlist creation | "2025-06-01T12:00:00Z" |
| updatedAt | string | ISO date-time of last update | "2025-06-10T09:45:00Z" |
post
/nontransactional/v1/watchListProfile