List modules

GET

modules

List modules

curl --request GET \
  --url https://api.osint.ly/modules \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.osint.ly/modules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.osint.ly/modules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.osint.ly/modules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.osint.ly/modules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "aggregations": {
    "categories": {
      "Social Media": 42,
      "Data Enrichment": 18
    },
    "featuredCount": 12,
    "searchTypes": {
      "Pseudonym": 60,
      "Email Address": 8
    },
    "totalCount": 68
  },
  "featuredModules": [
    {
      "description": "GitHub is a web-based platform for software development and version control using Git.",
      "featured": true,
      "id": "ba35f66f-1a28-412a-a334-2ddf51fb2d56",
      "installs": 15,
      "logo": "https://logos.osint.ly/github.com",
      "name": "Github",
      "slug": "github",
      "type": "Pseudonym"
    }
  ],
  "items": [
    {
      "description": "GitHub is a web-based platform for software development and version control using Git.",
      "featured": true,
      "id": "ba35f66f-1a28-412a-a334-2ddf51fb2d56",
      "installs": 15,
      "logo": "https://logos.osint.ly/github.com",
      "name": "Github",
      "slug": "github",
      "type": "Pseudonym"
    }
  ],
  "modules": [
    {
      "description": "GitHub is a web-based platform for software development and version control using Git.",
      "featured": true,
      "id": "ba35f66f-1a28-412a-a334-2ddf51fb2d56",
      "installs": 15,
      "logo": "https://logos.osint.ly/github.com",
      "name": "Github",
      "slug": "github",
      "type": "Pseudonym"
    }
  ],
  "pagination": {
    "hasNext": true,
    "hasPrevious": false,
    "limit": 12,
    "page": 1,
    "total": 68,
    "totalPages": 6
  },
  "total": 68
}

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

default:1

Page number

Required range: 1 <= x <= 10000

limit

integer

default:250

Number of modules to return per page

Required range: 1 <= x <= 250

sortBy

enum<string>

default:popular

Sort order for the module list

Available options:

popular,

usage-desc,

usage-asc,

recent,

name-asc,

name-desc,

rating

fields

enum<string>

Use preview to return the compact module payload used by catalog UIs

Available options:

preview

string

Search term matched against module name, type, description, and tags

Maximum string length: 120

searchType

string

default:All

Filter by module search type, or All for all types

Maximum string length: 80

Example:

"Pseudonym"

Response

Module catalog page

aggregations

object

required

Show child attributes

featuredModules

object[]

required

Show child attributes

items

object[]

required

Show child attributes

modules

object[]

required

Alias of items for clients that expect a module list property

Show child attributes

pagination

object

required

Show child attributes

total

integer

required

Required range: x >= 0

List modules

curl --request GET \
  --url https://api.osint.ly/modules \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.osint.ly/modules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.osint.ly/modules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.osint.ly/modules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.osint.ly/modules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "aggregations": {
    "categories": {
      "Social Media": 42,
      "Data Enrichment": 18
    },
    "featuredCount": 12,
    "searchTypes": {
      "Pseudonym": 60,
      "Email Address": 8
    },
    "totalCount": 68
  },
  "featuredModules": [
    {
      "description": "GitHub is a web-based platform for software development and version control using Git.",
      "featured": true,
      "id": "ba35f66f-1a28-412a-a334-2ddf51fb2d56",
      "installs": 15,
      "logo": "https://logos.osint.ly/github.com",
      "name": "Github",
      "slug": "github",
      "type": "Pseudonym"
    }
  ],
  "items": [
    {
      "description": "GitHub is a web-based platform for software development and version control using Git.",
      "featured": true,
      "id": "ba35f66f-1a28-412a-a334-2ddf51fb2d56",
      "installs": 15,
      "logo": "https://logos.osint.ly/github.com",
      "name": "Github",
      "slug": "github",
      "type": "Pseudonym"
    }
  ],
  "modules": [
    {
      "description": "GitHub is a web-based platform for software development and version control using Git.",
      "featured": true,
      "id": "ba35f66f-1a28-412a-a334-2ddf51fb2d56",
      "installs": 15,
      "logo": "https://logos.osint.ly/github.com",
      "name": "Github",
      "slug": "github",
      "type": "Pseudonym"
    }
  ],
  "pagination": {
    "hasNext": true,
    "hasPrevious": false,
    "limit": 12,
    "page": 1,
    "total": 68,
    "totalPages": 6
  },
  "total": 68
}

API Overview

Endpoints

Authorizations

Query Parameters

Response