WIIMs API Reference

Free Trial ➡

This REST API returns structured data for WIIMs or Why Is It Moving.

Best Practices

For optimal performance, we have a few recommendations.

Limit query, improve performance

Limiting the scope of the query will directly improve the latency of the API. This can be accomplished by using parameters such as symbols, or (preferably) by using updated for deltas.

Using Deltas

A common pattern is to use a delta to query for the latest change in a dataset. By reducing the amount of data available in the query, it will produce results with the least amount of latency and limited data an application will have to traverse.

In our case, we recommend tracking and querying by the latest updated timestamp.

One caveat to allow for some latency and second-only timestamps: when querying, set updated to a value 5 seconds earlier than you actually want. A query may look like:

/wiims?updated=LAGGED_TIMESTAMP Where LAGGED_TIMESTAMP is set to be five seconds less than the maximum value of the updated field in rows already pulled from our API.

API Endpoint
https://api.benzinga.com/api/v1
Response Content-Types

application/json

Schemes

https, http

Version

1.0.0

Authentication

token authentication

Type:
apiKey
Name:
token
In:
query

Playground

Endpoints

GET /wiims

Returns WIIMs data

Parameters

NameTypeLocationDescription
acceptstring , x ∈ { application/json (default) }header

Specifies return format.

countrystringquery

Country code for the region of coverage.

pageintegerquery

Page offset.

pagesizeinteger 50query

Number of results returned. Limit 500

search_keysstring (csv)query

One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities.

search_keys_typestring , x ∈ { symbol (default) }query

The type of identifier being searched. Supported types are currently a security symbol.

updated_sincenumber (double)query

Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated.

Timestamp may also be in python format to include millisecond updates.

Responses

CodeModelDescription
200 OK

success

Response (200 OK)

{
  "data": [
    {
      "id": "string",
      "description": "string",
      "search_key": "string",
      "security": {
        "exchange": "string",
        "symbol": "string",
        "name": "string",
        "country": "string",
        "cusip": "string",
        "isin": "string"
      },
      "created": "string (double)",
      "updated": "string (double)",
      "expired": "string (double)"
    }
  ]
}

Models

wiim: object

PropertyTypeDescription
idstring

Unique ID of this signal shared across all signal types

descriptionstring

The listed WIIMs for the security

search_keystring

Searched key, if active WIIMs

securityobject

Security

security.exchangestring

The listed exchange

security.symbolstring

The security symbol

security.namestring

The name of the security

security.countrystring

The country of the security

security.cusipstring

CUSIP, available for licenced customers

security.isinstring

ISIN, available for licenced customers

createdstring (double)

Created timestamp, UTC.

updatedstring (double)

Last updated timestamp, UTC.

expiredstring (double)

The timestamp, UTC, in which the WIIMs expires and is no longer considered active.

Structure (JSON)
{
  "id": "string",
  "description": "string",
  "search_key": "string",
  "security": {
    "exchange": "string",
    "symbol": "string",
    "name": "string",
    "country": "string",
    "cusip": "string",
    "isin": "string"
  },
  "created": "string (double)",
  "updated": "string (double)",
  "expired": "string (double)"
}