Get watchlist

GET

https://api.sureshake.com/v2/watchlists/{watchlistId}

Path parameters

watchlistId
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- name
  string
  required
- description
  string
  or null
  required
- isActive
  boolean
  required
- entityCount
  integer
  required
  minimum: 0
- createdAt
  string
  required
- updatedAt
  string
  required
- entities
  array of
  object
  required
  entityId
  string
  required
  format: uuid
  name
  string
  required
  slug
  string
  required
  logoUrl
  string
  or null
  required
  entityType
  string
  or null
  required
  primaryExchange
  string
  or null
  required
  primaryTicker
  string
  or null
  required
  sureshakeTicker
  string
  or null
  required
  addedAt
  string
  required
- containsEntity
  optional
  boolean
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Get watchlist

curl --request GET \
  --url 'https://api.sureshake.com/v2/watchlists/<watchlistId>'

const url = 'https://api.sureshake.com/v2/watchlists/<watchlistId>';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "isActive": true,
    "entityCount": 0,
    "containsEntity": true,
    "createdAt": "string",
    "updatedAt": "string",
    "entities": [
      {
        "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
        "name": "string",
        "slug": "string",
        "logoUrl": "string",
        "entityType": "string",
        "primaryExchange": "string",
        "primaryTicker": "string",
        "sureshakeTicker": "string",
        "addedAt": "string"
      }
    ]
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}