Stop watching a code

DELETE

/watchlists/{code}

const url = 'https://api.firmsapi.com/v1/watchlists/E430';
const options = {method: 'DELETE', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.firmsapi.com/v1/watchlists/E430 \
  --header 'x-api-key: <x-api-key>'

Idempotent: removed is false if you were not watching the code. Does not count toward your monthly calls.

Authorizations

apiKey

Parameters

Path Parameters

code

required

Code

4-character FIRMS code.

string

/^[A-Za-z0-9]{4}$/

4-character FIRMS code.

Responses

200

application/json

WatchRemovedResponse

object

data

required

WatchRemoved

object

code

required

Code

string

removed

required

Removed

boolean

meta

required

Meta

object

data_as_of

required

Any of:

string
null

string

source

required

Any of:

string
null

string

mode

required

Any of:

string
null

string

Allowed values: live test

build_id

Any of:

string
null

string

request_id

Any of:

string
null

string

Example

{
  "meta": {
    "mode": "live"
  }
}

400

Invalid request (not counted).

application/json

ErrorResponse

object

error

required

ErrorBody

object

code

required

Code

Stable, machine-readable error code.

string

message

required

Message

string

links

required

Links

docs always; billing, buy_pack, upgrade when they help.

object

key

additional properties

string

details

Details

meta

Any of:

Meta
null

Meta

object

data_as_of

required

Any of:

string
null

string

source

required

Any of:

string
null

string

mode

required

Any of:

string
null

string

Allowed values: live test

build_id

Any of:

string
null

string

request_id

Any of:

string
null

string

Example

{
  "error": {
    "code": "quota_exceeded"
  },
  "meta": {
    "mode": "live"
  }
}

401

Missing, invalid or revoked API key.

application/json

ErrorResponse

object

error

required

ErrorBody

object

code

required

Code

Stable, machine-readable error code.

string

message

required

Message

string

links

required

Links

docs always; billing, buy_pack, upgrade when they help.

object

key

additional properties

string

details

Details

meta

Any of:

Meta
null

Meta

object

data_as_of

required

Any of:

string
null

string

source

required

Any of:

string
null

string

mode

required

Any of:

string
null

string

Allowed values: live test

build_id

Any of:

string
null

string

request_id

Any of:

string
null

string

Example

{
  "error": {
    "code": "quota_exceeded"
  },
  "meta": {
    "mode": "live"
  }
}

403

Your plan does not include this endpoint (not counted).

application/json

ErrorResponse

object

error

required

ErrorBody

object

code

required

Code

Stable, machine-readable error code.

string

message

required

Message

string

links

required

Links

docs always; billing, buy_pack, upgrade when they help.

object

key

additional properties

string

details

Details

meta

Any of:

Meta
null

Meta

object

data_as_of

required

Any of:

string
null

string

source

required

Any of:

string
null

string

mode

required

Any of:

string
null

string

Allowed values: live test

build_id

Any of:

string
null

string

request_id

Any of:

string
null

string

Example

{
  "error": {
    "code": "quota_exceeded"
  },
  "meta": {
    "mode": "live"
  }
}