Newsware Websocket API 3.0.0

Subscribe to real-time news.

Servers

  • wss://api.newsware.com/ws/v3?apikey={apikey}wsspublic
    object
    apikeystring
    required

    Apikey assigned to the user by Newsware

Operations

  • REQUEST

    Create a news subscription

    Replies "ok" when subscription is created, "data" when new data is available, and "error" when an error occurred with the subscription.

    Operation IDsubscribe

    Available only on servers:

    Accepts the following message:

    Message IDSubscribeRequest
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

  • REQUEST

    Unsubscribe from one or all news subscriptions

    Replies "ok" when the subscription is removed and "error" to report any errors while unsubscribing.

    Operation IDunsubscribe

    Available only on servers:

    Accepts the following message:

    Message IDUnsubscribeRequest
    object

    Examples

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

Messages

  • #1
    Message IDSubscribeRequest
    object
  • #2
    Message IDUnsubscribeRequest
    object
  • #3
    Message IDResponseOk
    object

    Sent to acknowledge a request

  • #4
    Message IDResponseError
    object

    Sent to report an error in the request

  • #5
    Message IDResponseSubscriptionData
    object

    Sends news from a subscription

Schemas

  • object
  • object
  • string
  • string