Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Message direction

Format

Body

Additional info (possible values)

Request

JSON

{

  • "ticket":"string",
  • "watchlistIdwatchListId":"int"
  • "newWatchListName":"string"

}

 

Response

JSON

Code Block
linenumberstrue
languagehtml/xml
firstline1
{
 ResponseCode:int,
 Ticket:string
 Result:
 {
   Id:int,
   UserId:int,
   Name:string,
   Description:string,
   Type:int,
   CreateDate:DateTime,
   ModifyDate:DateTime,
   ReadOnly:false,
   SecurityList:
   [
    {
     Id:int,
     Symbol:string,
     Description:string,
     Exchange:string,
     Currency:string,
     AddedDate:DateTime,
     ModifyDate:DateTime,
     Enabled:bool,
     AllowTrade:bool,
     AllowMargin:bool,
     AllowShort:bool,
     Type:int,
     Source:int,
     SourceId:string,
     ParentId:int,
     Unit:string,
     MarginRate:decimal,
     ExpirationName:string,
     OptionType:int,
     ExpirationType:int,
     ExpirationDate:DateTime,
     StrikePrice:decimal,
     SeriesId:int,
     Name:string,
     UnderlyingSecuritySymbol:string,
    }
   ]
 }
}

ResponseCode values: 0, 1, 2, 3

Ticket is authentication ticket.

Result is watch list.

...

Message direction

Format

Body

Additional info (possible values)

Request

JSON

{
  • "ticket":"string",
  • "watchlistIdwatchListId":"int",
  • "securityId":"int"
}
 

Response

JSON

Code Block
linenumberstrue
languagehtml/xml
firstline1
{
 ResponseCode:int,
 Ticket:string
 Result:
 {
  Id:int,
  Symbol:string,
  Description:string,
  Exchange:string,
  Currency:string,
  AddedDate:DateTime,
  ModifyDate:DateTime,
  Enabled:bool,
  AllowTrade:bool,
  AllowMargin:bool,
  AllowShort:bool,
  Type:int,
  Source:int,
  SourceId:string,
  ParentId:int,
  Unit:string,
  MarginRate:decimal,
  ExpirationName:string,
  OptionType:int,
  ExpirationType:int,
  ExpirationDate:DateTime,
  StrikePrice:decimal,
  SeriesId:int,
  Name:string,
  UnderlyingSecuritySymbol:string,
 }
}

ResponseCode values: 0, 1, 2, 3

Ticket is authentication ticket.

Result is just added security.

...

Message direction

Format

Body

Additional info (possible values)

Request

JSON

{
  • "ticket":"string",
  • "watchlistIdwatchListId":"int",
  • "securityId":"int"
}
 

Response

JSON

Code Block
linenumberstrue
languagehtml/xml
firstline1
{
 ResponseCode:int,
 Ticket:string
 Result:
 {
   Id:int,
   UserId:int,
   Name:string,
   Description:string,
   Type:int,
   CreateDate:DateTime,
   ModifyDate:DateTime,
   ReadOnly:false,
   SecurityList:
   [
    {
     Id:int,
     Symbol:string,
     Description:string,
     Exchange:string,
     Currency:string,
     AddedDate:DateTime,
     ModifyDate:DateTime,
     Enabled:bool,
     AllowTrade:bool,
     AllowMargin:bool,
     AllowShort:bool,
     Type:int,
     Source:int,
     SourceId:string,
     ParentId:int,
     Unit:string,
     MarginRate:decimal,
     ExpirationName:string,
     OptionType:int,
     ExpirationType:int,
     ExpirationDate:DateTime,
     StrikePrice:decimal,
     SeriesId:int,
     Name:string,
     UnderlyingSecuritySymbol:string,
    }
   ]
  }
}

ResponseCode values: 0, 1, 2, 3

Ticket is authentication ticket.

Result is watch list.

...

  • "pageNumber":1,
  • "accountId":140,
  • "pageSize":"15",

X-Api-Key

Bug 182074: Issue with add-security-to-watch-list