< API Reference
POST
/watchlist
None
Create new watchlist

Example URI

https://api.livevol.com/v1/watchlist

Request Information

Body Parameters

CreateWatchlistParams

NameDescriptionTypeAdditional information
name

A watchlist name

string

Required

Max length: 32

The value of this field is case sensitive

description

A watchlist description

string

Required

Max length: 255

The value of this field is case sensitive

Request Formats

application/json, text/json

Sample:
{
  "name": "customWL1",
  "description": "My Custom Watchlist"
}

application/xml, text/xml

Sample:
<watchlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description>My Custom Watchlist</description>
  <name>customWL1</name>
</watchlist>

Response Information

Resource Description

WatchlistResult

NameDescriptionTypeAdditional information
id

Watchlist Id

globally unique identifier

None.

name

A watchlist name

string

None.

description

A watchlist description

string

None.

symbols

Symbols collection in current watchlist

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "c0f62535-3a82-4c00-a216-0f013ff310be",
  "name": "default",
  "description": "",
  "symbols": [
    "AAPL",
    "MSFT"
  ]
}

application/xml, text/xml

Sample:
<watchlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description></description>
  <id>c0f62535-3a82-4c00-a216-0f013ff310be</id>
  <name>default</name>
  <symbols>
    <symbol>AAPL</symbol>
    <symbol>MSFT</symbol>
  </symbols>
</watchlist>