Skip to main content
POST
/
search
/
module
/
once
Run one module immediately
curl --request POST \
  --url https://api.osint.ly/search/module/once \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "type": "Pseudonym",
    "value": "EstePrimeWorld"
  },
  "module_id": "2e48da48-0f14-457c-92d4-c44cd68b3fdc",
  "cache": {
    "mode": "prefer"
  }
}
'
{
  "data": {
    "search": {
      "id": "aff38600-cf11-45cc-a489-8706dcaaab88",
      "status": "finished",
      "created_at": "2026-06-14T19:20:14.209Z",
      "completed_at": "2026-06-14T19:20:16.419Z"
    },
    "module": {
      "id": "2e48da48-0f14-457c-92d4-c44cd68b3fdc",
      "name": "X (Twitter)"
    },
    "cards": [
      {
        "x_twitter_001": {
          "items": [
            {
              "label": "Username",
              "value": "EstePrimeWorld",
              "copy": true,
              "isdate": false,
              "islink": false
            }
          ]
        }
      }
    ]
  },
  "meta": {
    "environment": "production",
    "timestamp": "2026-06-14T19:20:16.419Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
query
object
required
​
module_id
string
required

ID of the module to execute. Exactly one module is executed per request.

Minimum string length: 1
​
cache
object

Response

Module executed and immediate cards returned

​
data
object
required
​
meta
object
required