Skip to content

openapi.md

Latest commit

 

History

History
1738 lines (1320 loc) · 49.9 KB

openapi.md

File metadata and controls

1738 lines (1320 loc) · 49.9 KB
title Intelx.io - Search API v0.8.0
language_tabs
shell
Shell
http
HTTP
language_clients
shell
http
toc_footers
<a href="https://github.com/IntelligenceX/SDK">Software Development Kit (SDK) and reference documents</a>
includes
search true
highlight_theme darkula
headingLevel 2

Intelx.io - Search API v0.8.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Internal search in "buckets" (e.g. usenet, web.public, whois). Needs X-Key header authorization, or as k=[key] query parameter. The API will return HTTP 401 Unauthorized in case the API key is invalid or not authorized.

Base URLs:

Terms of service Email: Intelligent X Web: Intelligent X License: License and Price

Authentication

  • API Key (ApiKeyQueryParam)

    • Parameter Name: k, in: query.

  • API Key (ApiKeyAuth)

    • Parameter Name: X-Key, in: header.

Default

Return a JSON object with the current user's API capabilities

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/authenticate/info \
  -H 'Accept: application/json' \
  -H 'X-Key: API_KEY'

GET https://2.intelx.io/authenticate/info HTTP/1.1
Host: 2.intelx.io
Accept: application/json

GET /authenticate/info

Return a JSON object with the current user's API capabilities

Example responses

200 Response

{
  "added": "2025-11-04T22:45:01.1220324Z",
  "buckets": [
    "darknet",
    "dns",
    "documents.public",
    "dumpster",
    "leaks.logs",
    "leaks.private",
    "leaks.public",
    "pastes",
    "usenet",
    "web.gov.ru",
    "web.public",
    "whois"
  ],
  "bucketsh": [
    "Darknet",
    "DNS",
    "Documents » Public",
    "Dumpster",
    "Leaks » Logs",
    "Leaks » Restricted",
    "Leaks » Public",
    "Pastes",
    "Usenet",
    "Web » Government » Ukraine",
    "Web » Public",
    "Whois"
  ],
  "preview": [],
  "previewh": [],
  "redacted": [],
  "redactedh": [],
  "paths": {
    "/authenticate/info": {
      "Path": "/authenticate/info",
      "Credit": 0,
      "CreditMax": 0,
      "CreditReset": 0
    },
    "/file/preview": {
      "Path": "/file/preview",
      "Credit": 9971,
      "CreditMax": 10000,
      "CreditReset": 2
    },
    "/file/read": {
      "Path": "/file/read",
      "Credit": 998,
      "CreditMax": 1000,
      "CreditReset": 2
    },
    "/file/treeview": {
      "Path": "/file/treeview",
      "Credit": 500,
      "CreditMax": 500,
      "CreditReset": 2
    },
    "/file/view": {
      "Path": "/file/view",
      "Credit": 998,
      "CreditMax": 1000,
      "CreditReset": 2
    },
    "/intelligent/search": {
      "Path": "/intelligent/search",
      "Credit": 479,
      "CreditMax": 500,
      "CreditReset": 2
    },
    "/intelligent/search/export": {
      "Path": "/intelligent/search/export",
      "Credit": 100,
      "CreditMax": 100,
      "CreditReset": 2
    },
    "/intelligent/search/result": {
      "Path": "/intelligent/search/result",
      "Credit": 0,
      "CreditMax": 0,
      "CreditReset": 0
    },
    "/intelligent/search/statistic": {
      "Path": "/intelligent/search/statistic",
      "Credit": 0,
      "CreditMax": 0,
      "CreditReset": 0
    },
    "/intelligent/search/terminate": {
      "Path": "/intelligent/search/terminate",
      "Credit": 0,
      "CreditMax": 0,
      "CreditReset": 0
    },
    "/item/selector/list/export": {
      "Path": "/item/selector/list/export",
      "Credit": 1000,
      "CreditMax": 1000,
      "CreditReset": 2
    },
    "/item/selector/list/human": {
      "Path": "/item/selector/list/human",
      "Credit": 1000,
      "CreditMax": 1000,
      "CreditReset": 2
    },
    "/phonebook/search": {
      "Path": "/phonebook/search",
      "Credit": 100,
      "CreditMax": 100,
      "CreditReset": 2
    },
    "/phonebook/search/export": {
      "Path": "/phonebook/search/export",
      "Credit": 100,
      "CreditMax": 100,
      "CreditReset": 2
    },
    "/phonebook/search/result": {
      "Path": "/phonebook/search/result",
      "Credit": 0,
      "CreditMax": 0,
      "CreditReset": 0
    }
  },
  "searchesactive": 0,
  "maxconcurrentsearches": 10
}

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

File preview

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/file/preview?sid=fb054e59c7eecab877b317d1f4204abbe4130c727a15ea6e2555e1ebdcd63540b54ecd3242a0a77f70a7e57a4dfc9b70712cfc80f3757beda93e3fc657b41ee7

GET https://2.intelx.io/file/preview?sid=fb054e59c7eecab877b317d1f4204abbe4130c727a15ea6e2555e1ebdcd63540b54ecd3242a0a77f70a7e57a4dfc9b70712cfc80f3757beda93e3fc657b41ee7 HTTP/1.1
Host: 2.intelx.io

GET /file/preview

File preview

Parameters

Name In Type Required Description
sid query string true none
f query integer false Format
l query integer false Result limit
c query integer false Data type
m query integer false Media
b query string false Bucket

Enumerated Values

Parameter Value
c 1
c 2
c 3
c 4

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad request None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Read a file's raw contents. Use this for direct data download.

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/file/view?storageid=string

GET https://2.intelx.io/file/view?storageid=string HTTP/1.1
Host: 2.intelx.io

GET /file/view

Show a file's contents based on its storageid (sid), convert to text where necessary.

Parameters

Name In Type Required Description
f query integer false format option:
storageid query string true Either the storage identifier or system identifier has to be specified.
bucket query string false - Specify the bucket to search
escape query integer false For text the default behavior (unless overwritten by &escape=0) is to escape HTML characters

Detailed descriptions

f: format option:

  • 0: textview of content
  • 1: hex view of content
  • 2: auto detect hex view or text view
  • 3: picture view
  • 4: not supported
  • 5: html inline view (sanitized)
  • 6: text view of pdf
  • 7: text view of html
  • 8: text view of word file

bucket: - Specify the bucket to search

escape: For text the default behavior (unless overwritten by &escape=0) is to escape HTML characters for safe placement of the text in HTML.

Enumerated Values

Parameter Value
escape 0
escape 1

Responses

Status Meaning Description Schema
200 OK Data as payload according to the type None
400 Bad Request Invalid Input None
404 Not Found item was not found None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

servers__intelligent_search

Code samples

# You can also use wget
curl -X SERVERS https://2.intelx.io/intelligent/search

SERVERS https://2.intelx.io/intelligent/search HTTP/1.1
Host: 2.intelx.io

SERVERS /intelligent/search

Responses

Status Meaning Description Schema
This operation does not require authentication

Initialize an intelligent search and return the ID of the task/search for further processing.

Code samples

# You can also use wget
curl -X POST https://2.intelx.io/intelligent/search?term=info%40intelx.io&maxresults=100&timeout=30&datefrom=2020-01-01%2000%3A00%3A00&dateto=2020-02-02%2023%3A59%3A59&sort=4&media=0 \
  -H 'Accept: application/json' \
  -H 'X-Key: API_KEY'

POST https://2.intelx.io/intelligent/search?term=info%40intelx.io&maxresults=100&timeout=30&datefrom=2020-01-01%2000%3A00%3A00&dateto=2020-02-02%2023%3A59%3A59&sort=4&media=0 HTTP/1.1
Host: 2.intelx.io
Accept: application/json

POST /intelligent/search

Initialize an intelligent search and return the ID of the task/search for further processing.

Parameters

Name In Type Required Description
term query string true The term must be a strong selector. These selector types are currently supported:
maxresults query integer true - Tells how many results to query maximum per bucket.
buckets query string false - Specify the buckets to search
timeout query integer true - Set a timeout value for the search. If omitted or set to 0, the default is used.
datefrom query string true - Set a starting date to begin the search from.
dateto query string true - Set an ending date to finish the search from.
sort query integer true - Define the way to sort search results.
media query integer true - Define the type of media to search for.
lookuplevel query integer false lookuplevel
terminate query array[string] false Optional: ID of previous search to terminate to save system resources.

Detailed descriptions

term: The term must be a strong selector. These selector types are currently supported:

  • Email address
  • Domain, including wildcards like *.example.com
  • URL
  • IPv4 & IPv6
  • CIDRv4 & CIDRv6
  • Phone Number
  • Bitcoin Address
  • MAC Address
  • IPFS Hash
  • UUID
  • Storage ID
  • System ID
  • Simhash
  • Credit card number
  • IBAN Soft selectors (generic terms) are not supported!

maxresults: - Tells how many results to query maximum per bucket.

buckets: - Specify the buckets to search

timeout: - Set a timeout value for the search. If omitted or set to 0, the default is used.

datefrom: - Set a starting date to begin the search from.

  • Example: 2020-01-01 00:00:00
  • Example: 2020-01-01 12:00:00

dateto: - Set an ending date to finish the search from.

  • Example: 2020-02-02 23:59:59
  • Example: 2020-02-02 00:00:00

sort: - Define the way to sort search results.

  • 0: No sorting.
  • 1: X-Score ASC. Least relevant items first.
  • 2: X-Score DESC. Most relevant items first.
  • 3: Date ASC. Oldest items first.
  • 4: Date DESC. Newest items first.

media: - Define the type of media to search for.

  • 0: Not set. (All media types)
  • 1: Paste document
  • 2: Paste User
  • 3: Forum
  • 4: Forum Board
  • 5: Forum Thread
  • 6: Forum Post
  • 7: Forum User
  • 8: Screenshot of a Website
  • 9: HTML copy of a website.
  • 10: Invalid, do not use.
  • 11: Invalid, do not use.
  • 12: Invalid, do not use.
  • 13: Tweet
  • 14: URL, high-level item having HTML copies as linked sub-items
  • 15: PDF document
  • 16: Word document
  • 17: Excel document
  • 18: Powerpoint document
  • 19: Picture
  • 20: Audio file
  • 21: Video file
  • 22: Container files including ZIP, RAR, TAR and others
  • 23: HTML file
  • 24: Text file

lookuplevel: lookuplevel

Example responses

200 Response

{
  "status": 0,
  "id": "61202067-543e-4e6a-8c23-11f9b8f008cf"
}

Responses

Status Meaning Description Schema
200 OK Success search Inline
400 Bad Request Invalid data None
401 Unauthorized Invalid api token; not authorized for buckets None
402 Payment Required if no credits available None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none Result status
» id string false none none

Links

LiveSearchResult => liveSearchResult

Parameter Expression
id $response.body#/id
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

Export intelligent search

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/intelligent/search/export?id=61202067-543e-4e6a-8c23-11f9b8f008cf&f=0

GET https://2.intelx.io/intelligent/search/export?id=61202067-543e-4e6a-8c23-11f9b8f008cf&f=0 HTTP/1.1
Host: 2.intelx.io

GET /intelligent/search/export

Exports search results as either a CSV summary or a ZIP archive. This endpoint requires the Search ID returned by /intelligent/search.

The CSV summary contains the following columns: Name, Date, Bucket, Media, Content Type, Size, System ID

See: https://help.intelx.io/api/search/#intelligentsearchexport

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")
l query integer false Result limit
f query integer true Format:

Detailed descriptions

f: Format:

Responses

Status Meaning Description Schema
200 OK Successful export. Response contains the file. The Content-Disposition header includes a suggested filename such as Search [Date].csv. None
204 No Content Search ID not found. No body returned. None
400 Bad Request Invalid input. Typically due to missing or malformed parameters. None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Fetch intelligent search result

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/intelligent/search/result?id=61202067-543e-4e6a-8c23-11f9b8f008cf&media=0 \
  -H 'Accept: application/json'

GET https://2.intelx.io/intelligent/search/result?id=61202067-543e-4e6a-8c23-11f9b8f008cf&media=0 HTTP/1.1
Host: 2.intelx.io
Accept: application/json

GET /intelligent/search/result

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")
limit query integer false Result limit
media query integer true - Define the type of media to search for.
statistics query integer false Add statistics
previewlines query integer false Preview lines count
bucket query string false - Specify the bucket to search
dateFrom query string(date-time) false Date from of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
dateTo query string(date-time) false Date to of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
reset query integer false Reset previous searches

Detailed descriptions

media: - Define the type of media to search for.

  • 0: Not set. (All media types)
  • 1: Paste document
  • 2: Paste User
  • 3: Forum
  • 4: Forum Board
  • 5: Forum Thread
  • 6: Forum Post
  • 7: Forum User
  • 8: Screenshot of a Website
  • 9: HTML copy of a website.
  • 10: Invalid, do not use.
  • 11: Invalid, do not use.
  • 12: Invalid, do not use.
  • 13: Tweet
  • 14: URL, high-level item having HTML copies as linked sub-items
  • 15: PDF document
  • 16: Word document
  • 17: Excel document
  • 18: Powerpoint document
  • 19: Picture
  • 20: Audio file
  • 21: Video file
  • 22: Container files including ZIP, RAR, TAR and others
  • 23: HTML file
  • 24: Text file

bucket: - Specify the bucket to search

Enumerated Values

Parameter Value
reset 0
reset 1

Example responses

200 Response

{
  "records": [
    {
      "systemid": "45fdc0d2-2550-4e66-8447-a21268d60b5a",
      "storageid": "string",
      "instore": true,
      "size": 0,
      "accesslevel": 0,
      "type": 0,
      "media": 0,
      "added": "2019-08-24T14:15:22Z",
      "date": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string",
      "xscore": 100,
      "simhash": 0,
      "bucket": "string",
      "tags": [
        {
          "class": 0,
          "value": "string"
        }
      ],
      "relations": [
        {
          "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
          "relation": 0
        }
      ],
      "accesslevelh": "string",
      "mediah": "string",
      "simhashh": "string",
      "typeh": "string",
      "tagsh": [
        {
          "class": 0,
          "classh": "string",
          "value": "string",
          "valueh": "string"
        }
      ],
      "randomid": "b2890775-4beb-4d72-9035-427f789d4e63",
      "bucketh": "string",
      "group": "string",
      "indexfile": "string"
    }
  ],
  "status": 0
}

Responses

Status Meaning Description Schema
200 OK Intelligent search result page. The client is expected to poll this
endpoint repeatedly and interpret the status code:

0 = Success with results (continue polling, more results available) 1 = No more results available (this response might still have results) 2 = Search ID not found 3 = No results yet available, keep trying 4 = Error|Inline| |400|Bad Request|Invalid input data|None| |401|Unauthorized|Not authorized. Verify the API key.|None| |404|Not Found|Search ID not found|None| |500|Internal Server Error|Internal API error|None|

Response Schema

Status Code 200

Name Type Required Restrictions Description
» records [allOf] false none Result records in this page

allOf

Name Type Required Restrictions Description
»» anonymous Item false none Generic item meta-data, as used for search results.
»»» systemid string(uuid) true none System identifier uniquely identifying the item
»»» storageid string false none Storage identifier, empty if not stored/available
»»» instore boolean false none Whether the data of the item is in store and the storageid is valid
»»» size integer(int64) false none Size in bytes of the item data
»»» accesslevel integer false none Native access level of the item
»»» type integer false none Low-level content type
»»» media integer false none High-level media type
»»» added string(date-time) false none When the item was added to the system
»»» date string(date-time) false none When the item was discovered or created
»»» name string false none Name or title
»»» description string false none Full description, text only
»»» xscore integer false none X-Score, ranking its relevancy, 0–100
»»» simhash integer(int64) false none Simhash of the item data
»»» bucket string false none Bucket identifier
»»» tags [Tag] false none Meta-data tags helping in classification of the item data
»»»» class integer(int32) true none Tag class
»»»» value string true none Tag value
»»» relations [Relationship] false none Related items
»»»» target string(uuid) true none Target item system ID
»»»» relation integer true none Relation type (see server implementation)

and

Name Type Required Restrictions Description
»» anonymous object false none Search result record, extends Item with human-readable fields.
»»» accesslevelh string false none Human friendly access level info
»»» mediah string false none Human friendly media type info
»»» simhashh string false none Human friendly simhash
»»» typeh string false none Human friendly content type info
»»» tagsh [PanelSearchResultTag] false none Human friendly tags
»»»» class integer(int32) false none Tag class
»»»» classh string false none Human friendly tag class
»»»» value string false none Tag value
»»»» valueh string false none Human friendly tag value
»»» randomid string(uuid) false none Random ID
»»» bucketh string false none Human friendly bucket name
»»» group string false none File group
»»» indexfile string false none Index file ID

continued

Name Type Required Restrictions Description
» status integer true none Status of the search result:
0 = Success with results (continue polling)
1 = No more results available
2 = Search ID not found
3 = No results yet available, keep trying
4 = Error

Enumerated Values

Property Value
status 0
status 1
status 2
status 3
status 4
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Intelligent search statistics

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/intelligent/search/statistic?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/intelligent/search/statistic?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /intelligent/search/statistic

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

Responses

Status Meaning Description Schema
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Terminate previous search

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/intelligent/search/terminate?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/intelligent/search/terminate?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /intelligent/search/terminate

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

Responses

Status Meaning Description Schema
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Lists all selectors for an item

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/item/selector/list?id=61202067-543e-4e6a-8c23-11f9b8f008cf \
  -H 'X-Key: API_KEY'

GET https://2.intelx.io/item/selector/list?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /item/selector/list

lists all selectors for an item from the first selector service that responds.

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

Responses

Status Meaning Description Schema
200 OK Success search None
400 Bad Request if invalid input id None
404 Not Found item not found None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

Lists all selectors for an item with human translation

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/item/selector/list/human?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/item/selector/list/human?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /item/selector/list/human

Lists all selectors for an item from the first selector service that responds with human translation.

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")
bucket query string false - Specify the bucket to search

Detailed descriptions

bucket: - Specify the bucket to search

Responses

Status Meaning Description Schema
200 OK with JSON structure SelectorLink None
400 Bad Request if invalid input id None
404 Not Found item not found None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Exports all selectors for an item

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/item/selector/list/export?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/item/selector/list/export?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /item/selector/list/export

Exports all selectors for an item from the first selector service that responds with human translation as CSV. CSV header: Item System ID, Selector, Selector Type, Selector Type Human Filename: "Selectors [System ID].csv"

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

Responses

Status Meaning Description Schema
200 OK Success, with data, Content-Disposition set None
204 No Content Download with content-disposition but item not available. This prevents redirection of the user to error page when providing a direct download link. None
400 Bad Request Invalid input. Returned if the encoding is invalid or a required parameter is missing. None
401 Unauthorized Unauthorized Authenticate: Access not authorized.
This may be due missing permission for API call or to selected buckets. None
402 Payment Required Payment Required Authenticate: No credits available. None
404 Not Found Not Found Item or identifier not found. None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Phonebook search

Code samples

# You can also use wget
curl -X POST https://2.intelx.io/phonebook/search?term=info%40intelx.io&target=0&maxresults=100&timeout=30&media=0 \
  -H 'X-Key: API_KEY'

POST https://2.intelx.io/phonebook/search?term=info%40intelx.io&target=0&maxresults=100&timeout=30&media=0 HTTP/1.1
Host: 2.intelx.io

POST /phonebook/search

Parameters

Name In Type Required Description
term query string true none
target query integer true none
buckets query string false - Specify the buckets to search
maxresults query integer true - Tells how many results to query maximum per bucket.
timeout query integer true - Set a timeout value for the search. If omitted or set to 0, the default is used.
media query integer true - Define the type of media to search for.
terminate query array[string] false Optional: ID of previous search to terminate to save system resources.

Detailed descriptions

buckets: - Specify the buckets to search

maxresults: - Tells how many results to query maximum per bucket.

timeout: - Set a timeout value for the search. If omitted or set to 0, the default is used.

media: - Define the type of media to search for.

  • 0: Not set. (All media types)
  • 1: Paste document
  • 2: Paste User
  • 3: Forum
  • 4: Forum Board
  • 5: Forum Thread
  • 6: Forum Post
  • 7: Forum User
  • 8: Screenshot of a Website
  • 9: HTML copy of a website.
  • 10: Invalid, do not use.
  • 11: Invalid, do not use.
  • 12: Invalid, do not use.
  • 13: Tweet
  • 14: URL, high-level item having HTML copies as linked sub-items
  • 15: PDF document
  • 16: Word document
  • 17: Excel document
  • 18: Powerpoint document
  • 19: Picture
  • 20: Audio file
  • 21: Video file
  • 22: Container files including ZIP, RAR, TAR and others
  • 23: HTML file
  • 24: Text file

Enumerated Values

Parameter Value
target 0
target 1
target 2
target 3

Responses

Status Meaning Description Schema
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

Export

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/phonebook/search/export?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/phonebook/search/export?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /phonebook/search/export

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")
l query integer false Result limit

Responses

Status Meaning Description Schema
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Fetch phonebook search result

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/phonebook/search/result?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/phonebook/search/result?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /phonebook/search/result

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")
l query integer false Result limit

Responses

Status Meaning Description Schema
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Get item meta-data

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/api/item/get?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/api/item/get?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /api/item/get

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

Responses

Status Meaning Description Schema
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Get item meta-data with human translation

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/api/item/get/human?id=61202067-543e-4e6a-8c23-11f9b8f008cf

GET https://2.intelx.io/api/item/get/human?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /api/item/get/human

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

Responses

Status Meaning Description Schema
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyQueryParam

Internal live search

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/live/search/internal?selector=info%40intelx.io \
  -H 'Accept: application/json' \
  -H 'X-Key: API_KEY'

GET https://2.intelx.io/live/search/internal?selector=info%40intelx.io HTTP/1.1
Host: 2.intelx.io
Accept: application/json

GET /live/search/internal

Initiates the search; will return status and search Id on success. Limit means max amount of records per bucket to return. Default 10.

  • Selector: Must be an email address, domain, social security number (US based), or credit card number.
  • Limit: In some cases, the API might return more results than specified in limit. If an upper hard limit is required, it must be enforced on the client side.
  • Bucket: Optional filter for searching only in the target bucket. See Appendix 1 for list.
  • In case a user makes a new search and the previous one shall be discarded; its search ID shall be specified in the “terminate” parameter to save system resources. Searches may consume Gigabytes of data, therefore any searches that are no longer required shall be terminated. Searches can also be manually terminated via the /live/search/terminate function.
  • Dates: From/to dates may be used as filter. Note that item’s dates are set to when the original data was published if available, or otherwise when it was indexed. This means that newly indexed items are often backdated.

Parameters

Name In Type Required Description
selector query string true Selector to search for
bucket query string false - Specify the bucket to search
skipinvalid query boolean false Specify to skip invalid entries (recommended). Default false.
limit query integer false Result limit
analyze query boolean false Default false.
datefrom query string(date-time) false Date from of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
dateto query string(date-time) false Date to of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
terminate query array[string] false Optional: ID of previous search to terminate to save system resources.

Detailed descriptions

bucket: - Specify the bucket to search

Example responses

200 Response

{
  "status": 0,
  "id": "61202067-543e-4e6a-8c23-11f9b8f008cf"
}

Responses

Status Meaning Description Schema
200 OK Success search Inline
400 Bad Request Invalid input None
401 Unauthorized Invalid api token None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer true none Result status
» id string true none none

Links

LiveSearchResult => liveSearchResult

Parameter Expression
id $response.body#/id
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

Terminating search

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/live/search/terminate?id=61202067-543e-4e6a-8c23-11f9b8f008cf \
  -H 'X-Key: API_KEY'

GET https://2.intelx.io/live/search/terminate?id=61202067-543e-4e6a-8c23-11f9b8f008cf HTTP/1.1
Host: 2.intelx.io

GET /live/search/terminate

To terminate an active search or export, use this function. Terminating a search that is no longer needed saves system resources. Since searches may read and process Gigabytes of data, it is highly appreciated if users terminate searches that are no longer needed.

Terminating a search that is already terminated has no effect.

Parameters

Name In Type Required Description
id query string true Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

Responses

Status Meaning Description Schema
204 No Content Success with no content None
400 Bad Request Invalid input None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

Fetch results from internal live search

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/accounts/csv?selector=info%40intelx.io \
  -H 'X-Key: API_KEY'

GET https://2.intelx.io/accounts/csv?selector=info%40intelx.io HTTP/1.1
Host: 2.intelx.io

GET /accounts/csv

This is the API used by the “Export Leaked Accounts” tab of the Identity Portal. It only supports domains and email addresses as input.

The response is the same as for /live/search/internal, returning a status and the search job ID. In case a user makes a new export and the previous one shall be discarded; its search ID shall be specified in the “terminate” parameter to save system resources. Searches may consume Gigabytes of data, therefore any searches that are no longer required shall be terminated. Searches can also be manually terminated via the /live/search/terminate function.

Parameters

Name In Type Required Description
selector query string true Search term
bucket query string false - Specify the bucket to search
limit query integer false Result limit
datefrom query string(date-time) false Date from of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
dateto query string(date-time) false Date to of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
terminate query array[string] false Optional: ID of previous search to terminate to save system resources.

Detailed descriptions

bucket: - Specify the bucket to search

Responses

Status Meaning Description Schema
200 OK Success with JSON LiveSearchResponse None
400 Bad Request Invalid input None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

servers__accounts_1

Code samples

# You can also use wget
curl -X SERVERS https://2.intelx.io/accounts/1

SERVERS https://2.intelx.io/accounts/1 HTTP/1.1
Host: 2.intelx.io

SERVERS /accounts/1

Responses

Status Meaning Description Schema
This operation does not require authentication

Synchronous Export Leaked Accounts

Code samples

# You can also use wget
curl -X GET https://2.intelx.io/accounts/1?selector=info%40intelx.io&timeout=30 \
  -H 'X-Key: API_KEY'

GET https://2.intelx.io/accounts/1?selector=info%40intelx.io&timeout=30 HTTP/1.1
Host: 2.intelx.io

GET /accounts/1

Use this function to query leaked accounts and return them immediately.

Note: You should use the asynchronous function /accounts/csv as this one might miss results that are not available within the given timeout. Searching for leaked accounts may take minutes, especially when searching for domains that have thousands of results. Internally the API must fetch the entire data for each individual result which often results internally in Gigabytes of traffic and potentially causes delays.

The default timeout is 10 minutes. The client must make sure to allow for such high HTTP timeouts on the client side. The timeout must not be higher than 1 hour, which is the HTTP server write timeout.

Parameters

Name In Type Required Description
selector query string true Search term
bucket query string false - Specify the bucket to search
limit query integer false Result limit
timeout query integer true - Set a timeout value for the search. If omitted or set to 0, the default is used.
datefrom query string(date-time) false Date from of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
dateto query string(date-time) false Date to of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)
terminate query array[string] false Optional: ID of previous search to terminate to save system resources.

Detailed descriptions

bucket: - Specify the bucket to search

timeout: - Set a timeout value for the search. If omitted or set to 0, the default is used.

Responses

Status Meaning Description Schema
200 OK JSON array of CSVRecord None
400 Bad Request Invalid input None
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth

Schemas

Tag

{
  "class": 0,
  "value": "string"
}

Properties

Name Type Required Restrictions Description
class integer(int32) true none Tag class
value string true none Tag value

Relationship

{
  "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
  "relation": 0
}

Properties

Name Type Required Restrictions Description
target string(uuid) true none Target item system ID
relation integer true none Relation type (see server implementation)

Item

{
  "systemid": "45fdc0d2-2550-4e66-8447-a21268d60b5a",
  "storageid": "string",
  "instore": true,
  "size": 0,
  "accesslevel": 0,
  "type": 0,
  "media": 0,
  "added": "2019-08-24T14:15:22Z",
  "date": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "xscore": 100,
  "simhash": 0,
  "bucket": "string",
  "tags": [
    {
      "class": 0,
      "value": "string"
    }
  ],
  "relations": [
    {
      "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
      "relation": 0
    }
  ]
}

Generic item meta-data, as used for search results.

Properties

Name Type Required Restrictions Description
systemid string(uuid) true none System identifier uniquely identifying the item
storageid string false none Storage identifier, empty if not stored/available
instore boolean false none Whether the data of the item is in store and the storageid is valid
size integer(int64) false none Size in bytes of the item data
accesslevel integer false none Native access level of the item
type integer false none Low-level content type
media integer false none High-level media type
added string(date-time) false none When the item was added to the system
date string(date-time) false none When the item was discovered or created
name string false none Name or title
description string false none Full description, text only
xscore integer false none X-Score, ranking its relevancy, 0–100
simhash integer(int64) false none Simhash of the item data
bucket string false none Bucket identifier
tags [Tag] false none Meta-data tags helping in classification of the item data
relations [Relationship] false none Related items

PanelSearchResultTag

{
  "class": 0,
  "classh": "string",
  "value": "string",
  "valueh": "string"
}

Properties

Name Type Required Restrictions Description
class integer(int32) false none Tag class
classh string false none Human friendly tag class
value string false none Tag value
valueh string false none Human friendly tag value

SearchResult

{
  "systemid": "45fdc0d2-2550-4e66-8447-a21268d60b5a",
  "storageid": "string",
  "instore": true,
  "size": 0,
  "accesslevel": 0,
  "type": 0,
  "media": 0,
  "added": "2019-08-24T14:15:22Z",
  "date": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "xscore": 100,
  "simhash": 0,
  "bucket": "string",
  "tags": [
    {
      "class": 0,
      "value": "string"
    }
  ],
  "relations": [
    {
      "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
      "relation": 0
    }
  ],
  "accesslevelh": "string",
  "mediah": "string",
  "simhashh": "string",
  "typeh": "string",
  "tagsh": [
    {
      "class": 0,
      "classh": "string",
      "value": "string",
      "valueh": "string"
    }
  ],
  "randomid": "b2890775-4beb-4d72-9035-427f789d4e63",
  "bucketh": "string",
  "group": "string",
  "indexfile": "string"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous Item false none Generic item meta-data, as used for search results.

and

Name Type Required Restrictions Description
anonymous object false none Search result record, extends Item with human-readable fields.
» accesslevelh string false none Human friendly access level info
» mediah string false none Human friendly media type info
» simhashh string false none Human friendly simhash
» typeh string false none Human friendly content type info
» tagsh [PanelSearchResultTag] false none Human friendly tags
» randomid string(uuid) false none Random ID
» bucketh string false none Human friendly bucket name
» group string false none File group
» indexfile string false none Index file ID