Watch a code

PUT

/watchlists/{code}

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

• Production

Idempotent: watching a code twice keeps the original created_at. The code must be on the FIRMS list (deleted codes are fine). 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

OK

Media type application/json

WatchEntryResponse

object

data

required

WatchEntry

object

code

required

Code

string

created_at

required

Created At

string

facility

required

Any of:

FacilitySummary

FacilitySummary

object

code

required

Code

string

name

required

Name

string

status

required

Status

string

Allowed values: active deleted

type

required

Any of:

FacilityType

FacilityType

object

code

required

Code

string

label

required

Label

string

null

null

city

required

Any of:

string

string

null

null

state

required

Any of:

string

string

null

null

port

required

Any of:

string

string

null

null

null

null

meta

required

Meta

object

data_as_of

required

Any of:

string

string

null

null

source

required

Any of:

string

string

null

null

mode

required

Any of:

string

string

Allowed values: live test

null

null

build_id

Any of:

string

string

null

null

request_id

Any of:

string

string

null

null

Example

{
  "data": {
    "facility": {
      "status": "active",
      "type": {
        "code": "03",
        "label": "Pier or terminal"
      }
    }
  },
  "meta": {
    "mode": "live"
  }
}

400

Invalid request (not counted).

Media type 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

Meta

object

data_as_of

required

Any of:

string

string

null

null

source

required

Any of:

string

string

null

null

mode

required

Any of:

string

string

Allowed values: live test

null

null

build_id

Any of:

string

string

null

null

request_id

Any of:

string

string

null

null

null

null

Example

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

401

Missing, invalid or revoked API key.

Media type 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

Meta

object

data_as_of

required

Any of:

string

string

null

null

source

required

Any of:

string

string

null

null

mode

required

Any of:

string

string

Allowed values: live test

null

null

build_id

Any of:

string

string

null

null

request_id

Any of:

string

string

null

null

null

null

Example

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

403

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

Media type 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

Meta

object

data_as_of

required

Any of:

string

string

null

null

source

required

Any of:

string

string

null

null

mode

required

Any of:

string

string

Allowed values: live test

null

null

build_id

Any of:

string

string

null

null

request_id

Any of:

string

string

null

null

null

null

Example

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

404

Not found (counted: it is a lookup result).

Media type 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

Meta

object

data_as_of

required

Any of:

string

string

null

null

source

required

Any of:

string

string

null

null

mode

required

Any of:

string

string

Allowed values: live test

null

null

build_id

Any of:

string

string

null

null

request_id

Any of:

string

string

null

null

null

null

Example

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