Search facilities

GET

/search

curl --request GET \
  --url 'https://api.firmsapi.com/v1/search?q=example' \
  --header 'x-api-key: <x-api-key>'

Authorizations

• apiKey

Parameters

Query Parameters

q

required

string

Free text: name, address or code

port

string

Limit to a CBP port

Responses

200

OK

Media type application/json

object

meta

object

data_as_of

string format: date

source

string

mode

string

Allowed values: live test

Example

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

401

Error

Media type application/json

object

error

object

code

string

message

string

links

object

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "links": {}
  }
}

429

Error

Media type application/json

object

error

object

code

string

message

string

links

object

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "links": {}
  }
}