Skip to main content
POST
/
v1
/
screenings
/
search
Search screenings
curl --request POST \
  --url https://api.metal.ai/v1/screenings/search \
  --header 'Content-Type: application/json' \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>' \
  --data '
{
  "query": "industrial automation suppliers",
  "page": 1,
  "limit": 20
}
'
{
  "data": [
    {
      "id": "<string>",
      "company": "<string>",
      "deal": "<string>",
      "status": "completed",
      "industry": "<string>",
      "sector": "<string>",
      "subsector": "<string>",
      "dataEntities": [
        "<string>"
      ],
      "sections": [
        {}
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "page": 1,
    "limit": 20,
    "totalCount": 134,
    "totalPages": 7
  }
}

Authorizations

x-metal-client-id
string
header
required

The Client ID of your API key.

x-metal-api-key
string
header
required

The secret value of your API key.

Body

application/json
query
string
required

The search query.

Example:

"industrial automation suppliers"

page
integer
default:1

Page number, starting at 1.

limit
integer
default:20

Results per page.

Response

Ranked screenings results.

data
object[]
metadata
object

Pagination details returned by search endpoints.