v1

latestOpenAPI 3.1.02026-07-265111.5 MB

Copy of Streamed search request

Live result feed

post/v2/request/stream

Headers

api-keystring required

Request body

type'email' | 'phone' | 'username' | 'name' | 'wallet' required

The query input type.

querystring required

The search query.

timeoutinteger

Specify the amount of time you want the request to run for (recommended 60, max 80, min 25). For example, if you set 30 seconds, only modules that finish within 30 seconds will return results; slower ones will be skipped.

exact_matchboolean

When searching names, enabling "exact_match" will return only results that match the exact name (or very close permutations of it), filtering out partial or loosely related matches.

premiumboolean

Enables premium modules (e.g., Snapchat, TikTok). When a premium module is applicable, it costs +3 additional credits; for input types where no premium modules exist, no extra credits are charged.

premium_modules_onlyboolean

Only return premium modules (Total credit cost: 3)

Response

200

modulestring

pretty_dataobject

statusstring

querystring

fromstring

reliable_sourceboolean

Example response

[
  {
    "module": "maps",
    "data": {
      "visibility": "XXXXXXX",
      "stats": {
        "Reviews": "XXXXXXX",
        "Ratings": "XXXXXXX",
        "Photos": "XXXXXXX",
        "Videos": "XXXXXXX",
        "Captions": "XXXXXXX",
        "Answers": "XXXXXXX",
        "Edits": "XXXXXXX",
        "Places added": "XXXXXXX",
        "Roads added": "XXXXXXX",
        "Facts checked": "XXXXXXX",
        "Q&A": "XXXXXXX"
      },
      "reviews": [
        {
          "id": "XXXXXXX",
          "location": {
            "id": "XXXXXXX",
            "address": "XXXXXXX",
            "tags": [
              "XXXXXXX"
            ],
            "position": {
              "latitude": "XXXXXXX",
              "longitude": "XXXXXXX"
            },
            "cost": "XXXXXXX",
            "name": "XXXXXXX",
            "types": [
              {
                "id": "XXXXXXX",
                "icon": "XXXXXXX",
                "icon_color": "XXXXXXX",
                "bg_color": "XXXXXXX",
                "name": "XXXXXXX"
              }
            ]
          },
          "comment": "XXXXXXX",
          "rating": "XXXXXXX",
          "approximative_date": "XXXXXXX"
        }
      ]
    },
    "front_schemas": [
      {
        "map": [
          {
            "id": "XXXXXXX",
            "location": {
              "id": "XXXXXXX",
              "address": "XXXXXXX",
              "tags": [
                "XXXXXXX"
              ],
              "position": {
                "latitude": "XXXXXXX",
                "longitude": "XXXXXXX"
              },
              "cost": "XXXXXXX",
              "name": "XXXXXXX",
              "types": [
                {
                  "id": "XXXXXXX",
                  "icon": "XXXXXXX",
                  "icon_color": "XXXXXXX",
                  "bg_color": "XXXXXXX",
                  "name": "XXXXXXX"
                }
              ]
            },
            "comment": "XXXXXXX",
            "rating": "XXXXXXX",
            "approximative_date": "XXXXXXX"
          }
        ]
      }
    ],
    "spec_format": [
      {
        "registered": {
          "proper_key": "Registered",
          "value": true,
          "type": "bool"
        },
        "platform_variables": [
          {
            "key": "reviews",
            "proper_key": "Reviews",
            "value": [
              {
                "id": "XXXXXXX",
                "location": {
                  "id": "XXXXXXX",
                  "address": "XXXXXXX",
                  "tags": [
                    "XXXXXXX"
                  ],
                  "position": {
                    "latitude": "XXXXXXX",
                    "longitude": "XXXXXXX"
                  },
                  "cost": "XXXXXXX",
                  "name": "XXXXXXX",
                  "types": [
                    {
                      "id": "XXXXXXX",
                      "icon": "XXXXXXX",
                      "icon_color": "XXXXXXX",
                      "bg_color": "XXXXXXX",
                      "name": "XXXXXXX"
                    }
                  ]
                },
                "comment": "XXXXXXX",
                "rating": "XXXXXXX",
                "approximative_date": "XXXXXXX"
              }
            ],
            "type": "list"
          }
        ]
      }
    ],
    "status": "XXXXXXX",
    "query": "XXXXXXX",
    "from": "XXXXXXX",
    "reliable_source": true
  }
]