Skip to content

Notify:CreateScan

Creates a persistent Scan and returns the assigned identifier, given the scanner parameters and details.

Controller: Notify
Topic: CreateScan
Action: Publish
Permissions: None

NameTypeExpectDescription
DetailsObjectAlwaysA Scan Details object for identification.
ParametersObjectAlwaysA Scan Parameters object for describing the scan rules.
IsActiveBooleanSometimesAn optional flag setting whether the Scan should be Active when created. If omitted, defaults to true.
NameTypeExpectDescription
NameStringAlwaysThe user-defined name for the Scan.
DescriptionStringSometimesAn optional description providing further details of the Scan.
MetadataObjectAlwaysAn user-defined object with string values.
NameTypeExpectDescription
TypeStringAlwaysThe scanner type.
CriteriaAnyAlwaysThe parameters of the Scan. Format depends on the type.
TargetAnyAlwaysThe targeting information for the Scan. Format depends on the type.
NotificationsArraySometimesAn array of Notification Parameters objects that describe how this Scan should notify of changes.

See Appendix J1 - Scanners for more information on scanner criteria and targets.

NameTypeExpectDescription
ChannelIDStringAlwaysThe identifier of a Notification Channel.
CultureCodeStringSometimesAn optional culture identification code. If omitted, notifications will be sent in English.
MinimumStableTimeSometimesThe minimum amount of time a Scan must match before a notification can be sent.
MinimumElapsedTimeSometimesThe minimum amount of time since the last notification before a new one can be sent.
SettingsAnySometimesAny channel-specific settings for this notification source.

See Appendix K - Distribution Channels and the Channel Controller for more information on Notification Channels and Channel settings.

NameTypeExpectDescription
ScanIDStringAlwaysA unique identifier of the new Scan.

Send:

{"Controller":"Notify","Topic":"CreateScan","TransactionID":1,"Data":{
"Parameters":{
"Type":"Market.Scan",
"Criteria":["IsIndex"],
"Target":["ASX[Demo]"],
"Notifications":[
{"Channel":"j5Tm6X"}
]
},
"Details":{
"Name":"Indexes",
"Description":"Scan that matches all indexes",
"Metadata":{"Category":"User"}
},
"IsActive":false
}}

Receive:

{"Controller":"Notify","Topic":"CreateScan","TransactionID":1,"Data":"Data":{
"ScanID":"Umk8R2"
}}