Offensive OSINT

Open Source Surveillance API

Authentication

Workflow

Modules

Location

Add Workspace

Search

Get progress

Get search results

Check errors

Additional endpoints

Hashtag monitoring

Add Hashtag

Get all Hashtags

Get Hashtag posts by type

Default

Open Source Surveillance

Production

Sandbox

<p class="slate-p " >This is documentation regarding Open Source Surveillance system - <a href="https://os-surveillance.io" target="_self">https://os-surveillance.io</a></p><p class="slate-p " >Search</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Social media</div></li><li class="slate-li " ><div style="position:relative">Events</div></li><li class="slate-li " ><div style="position:relative">Crimes</div></li><li class="slate-li " ><div style="position:relative">Critical Infrastructure</div></li><li class="slate-li " ><div style="position:relative">Public Cameras</div></li><li class="slate-li " ><div style="position:relative">Internet Exposed Devices</div></li><li class="slate-li " ><div style="position:relative">Wifi networks</div></li><li class="slate-li " ><div style="position:relative">Transportation system</div></li><li class="slate-li " ><div style="position:relative">News</div></li><li class="slate-li " ><div style="position:relative">and more</div></li></ul><p class="slate-p " >based on coordinates</p><p class="slate-p " >Search</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Telegram</div></li><li class="slate-li " ><div style="position:relative">Twitter</div></li><li class="slate-li " ><div style="position:relative">Instagram</div></li><li class="slate-li " ><div style="position:relative">Threads</div></li><li class="slate-li " ><div style="position:relative">Youtube</div></li><li class="slate-li " ><div style="position:relative">Tiktok</div></li></ul><p class="slate-p " >based on hashtag</p><p class="slate-p " ></p><p class="slate-p " ></p>

This is documentation regarding Open Source Surveillance system - 

<p class="slate-p " >Below script</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Creates new workspace with coordinates in New York by making request to /addCoordinates</div></li><li class="slate-li " ><div style="position:relative">Search Flickr and Vkontakte posts in provided coordinates and bounding box by making request to /search</div></li><li class="slate-li " ><div style="position:relative">Ask for task status by making request to /getProgress/{search_id}</div></li><li class="slate-li " ><div style="position:relative">Retrieve search results when it&apos;s ready by making request to /getSearchResults/{search_id}</div></li><li class="slate-li " ><div style="position:relative">More informatoin here <a href="https://github.com/woj-ciech/os_surveillance-api" target="_self">https://github.com/woj-ciech/os_surveillance-api</a></div></li></ul><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-python keep-markup drop-tokens"><div class="slate-code_line">import requests
import time</div><div class="slate-code_line">headers = {
&quot;Authorization&quot;: &quot;Bearer XXXX&quot;,
&quot;Content-Type&quot;: &quot;application/json&quot;
}
BASE_URL = &quot;https://osint.os-surveillance.io/api&quot;</div><div class="slate-code_line">modules_to_run = [&quot;flickr&quot;, &quot;vkontakte&quot;]</div><div class="slate-code_line">#Add new workspace to the database</div><div class="slate-code_line"></div><div class="slate-code_line">def add_workspace():</div><div class="slate-code_line">  url = BASE_URL + &quot;/addCoordinates/&quot;</div><div class="slate-code_line">  </div><div class="slate-code_line">  payload = {</div><div class="slate-code_line">    &quot;title&quot;: &quot;New York&quot;,</div><div class="slate-code_line">    &quot;position&quot;: {</div><div class="slate-code_line">      &quot;lat&quot;: 40.72020796700515,</div><div class="slate-code_line">      &quot;lng&quot;: -74.0401684945897</div><div class="slate-code_line">    },</div><div class="slate-code_line">    &quot;radius&quot;: 30000</div><div class="slate-code_line">  }</div><div class="slate-code_line">  </div><div class="slate-code_line">  response = requests.post(url, headers=headers, json=payload)</div><div class="slate-code_line">  </div><div class="slate-code_line">  workspace_id = response.json()[&apos;workspace_id&apos;]</div><div class="slate-code_line">  </div><div class="slate-code_line">  return workspace_id</div><div class="slate-code_line"> </div><div class="slate-code_line"> </div><div class="slate-code_line">#Search for data in the workspace</div><div class="slate-code_line">#pass workspace_id from add_workspace()</div><div class="slate-code_line">#include latitude, longitude and bounding box of the area</div><div class="slate-code_line">def search(wokspace_id):
  url = BASE_URL + f&quot;/search/&quot;</div><div class="slate-code_line">  payload = {</div><div class="slate-code_line">      &quot;options&quot;:</div><div class="slate-code_line">          modules_to_run,</div><div class="slate-code_line">      &quot;keywords&quot;:None,</div><div class="slate-code_line">      &quot;date_from&quot;:None,</div><div class="slate-code_line">      &quot;date_to&quot;:None,</div><div class="slate-code_line">      &quot;only_new&quot;:False,</div><div class="slate-code_line">      &quot;coordinates_id&quot;:wokspace_id,</div><div class="slate-code_line">      &quot;lat&quot;:40.71846412371451, # center latitude</div><div class="slate-code_line">      &quot;lng&quot;:-73.99740740984262, # center longitude</div><div class="slate-code_line">      &quot;ne_lat&quot;:40.74334880686837, # north east latitude</div><div class="slate-code_line">      &quot;ne_lng&quot;:-73.81237074710944, # north east longitude</div><div class="slate-code_line">      &quot;sw_lat&quot;:40.67945984569057, # south west latitude</div><div class="slate-code_line">      &quot;sw_lng&quot;:-74.16341826297858 # south west longitude</div><div class="slate-code_line">  }</div><div class="slate-code_line">  </div><div class="slate-code_line">  response = requests.request(&quot;POST&quot;, url, headers=headers, json=payload)</div><div class="slate-code_line">  </div><div class="slate-code_line">  search_pk = response.json()[&apos;search_pk&apos;]</div><div class="slate-code_line">  </div><div class="slate-code_line">  return search_pk</div><div class="slate-code_line"></div><div class="slate-code_line">#Check progress of the search request</div><div class="slate-code_line">  def get_progress(search_pk):
  url = BASE_URL + f&quot;/getProgress/{search_pk}/&quot;</div><div class="slate-code_line">  response = requests.request(&quot;GET&quot;, url, headers=headers)</div><div class="slate-code_line">  </div><div class="slate-code_line">  return response.json()</div><div class="slate-code_line"></div><div class="slate-code_line">#Get results of the search request</div><div class="slate-code_line">def get_results(search_pk):
  url = BASE_URL + f&quot;/getSearchResults/{search_pk}/&quot;</div><div class="slate-code_line">  response = requests.request(&quot;GET&quot;, url, headers=headers)</div><div class="slate-code_line">  r_json = response.json()</div><div class="slate-code_line">  </div><div class="slate-code_line">  return response.json()</div><div class="slate-code_line"></div><div class="slate-code_line">def check_errors():
  url = BASE_URL + &quot;/checkErrors/&quot;</div><div class="slate-code_line">  response = requests.request(&quot;GET&quot;, url, headers=headers)</div><div class="slate-code_line">  </div><div class="slate-code_line">  return response.json()[&apos;errors&apos;]</div><div class="slate-code_line">  pp = get_progress(&quot;21&quot;)</div><div class="slate-code_line"></div><div class="slate-code_line">workspace_id = add_workspace()
search_pk = search(workspace_id) # next time when searching in this area, use same workspace_id</div><div class="slate-code_line">while True:
  progress = get_progress(search_pk)
  print(progress[&apos;progress&apos;])
    if progress[&apos;progress&apos;] == 100.0:
      results = get_results(search_pk)
      break
    else:
      time.sleep(1)</div><div class="slate-code_line"></div><div class="slate-code_line">for result in results:
  for item in result[&apos;objects&apos;]:
    print(item)
    # print(item[&apos;title&apos;])
    # print(item[&apos;timestamp&apos;])
    # print(item[&apos;photo_url&apos;])
    # print(item[&apos;location&apos;])</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >Create new workspace based on latitude, longitude and radius. Title is also mandatory.</p><p class="slate-p " >Maximum radius is 3000000m.</p>

Create new workspace based on latitude, longitude and radius. Title is also mandatory.

title

position

radius

Authorization

Content-Type

workspace_id

error

<p class="slate-p " >Run modules for given workspace and coordinates.</p><p class="slate-p " >You must provide centre of your search and bounding box.</p><p class="slate-p " >Bounding box must be inside of the bounding box as defined in Workspace.</p><div class="slate-div"></div><p class="slate-p " ><strong class="slate-bold">Options</strong> parameter contains list of modules to run.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">flickr</div></li><li class="slate-li " ><div style="position:relative">vkontakte</div></li></ul><p class="slate-p " >All modules are described in Modules section.</p><div class="slate-div"></div><p class="slate-p " >Possible error messages:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Please active your account.</div></li><li class="slate-li " ><div style="position:relative">Coordinates are not in the bounding box</div></li><li class="slate-li " ><div style="position:relative">Bounding box is not inside the workspace bounding box</div></li></ul><p class="slate-p " ></p>

Run modules for given workspace and coordinates.

You must provide centre of your search and bounding box.

Bounding box must be inside of the bounding box as defined in Workspace.

 parameter contains list of modules to run.

All modules are described in Modules section.

options

keywords

date_from

date_to

coordinates_id

ne_lat

ne_lng

sw_lat

sw_lng

zoom

search_pk

List of blocked modules due to lack of credits

blocked_modules

message

<p class="slate-p " >Get progress of the running modules.</p>

The unique identifier of the task for which progress is being requested.

completed

total

progress

<p class="slate-p " >Get search results after all or some modules finished</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Get search results after all or some modules finished

The unique identifier for the search request that was made in order to retrieve the search results.

<p class="slate-p " >Some modules might not run properly, to find out which ones; endpoint checkErrors needs to be queried, after get progress returned all tasks as done.</p><p class="slate-p " >Include previously obtained “search_pk”</p>

Some modules might not run properly, to find out which ones; endpoint checkErrors needs to be queried, after get progress returned all tasks as done.

Include previously obtained “search_pk”

errors

<p class="slate-p " >Below endpoints provide additional features like get workspaces, user information, database search or querying particular item.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Below endpoints provide additional features like get workspaces, user information, database search or querying particular item.

<p class="slate-p " >Search across all gathered items in database</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Search across all gathered items in database

Search database

query

person_or_item

item_type

results

count

<p class="slate-p " >Show all items that belong to the given workspace</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Show all items that belong to the given workspace

Show all items

The unique identifier for the resource to retrieve information for in the "Show all read" endpoint.

<p class="slate-p " >Remove workspace and associated items</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Remove Workspace

<p class="slate-p " >Get information about current user and credits usage</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Get information about current user and credits usage

Get user info

airbnb_requests

alltrails_requests

weather_requests

amber_alerts_requests

cameras_overpass_requests

crimes_requests

flickr_requests

instagram_requests

incidents_requests

planes_requests

shodan_requests

snapchat_requests

surveillance_cameras_requests

sportstracker_requests

strava_requests

traffic_cameras_requests

vessels_requests

vkontakte_requests

weibo_requests

wigle_requests

windy_requests

news_requests

worldcam_requests

youtube_requests

places_requests

wikiloc_requests

amtrak_requests

is_active

auth0_user

wigle_limit

shodan_limit

other_limit

offenders_requests

ticketmaster_requests

zillow_requests

eventbrite_requests

craigslist_requests

meetup_requests

nextdoor_requests

username_requests

username_limit

outdooractive_requests

waze_requests

ai_geolocate_requests

ai_geolocate_limit

findpenguins_requests

bikemap_requests

facecheck_requests

facecheck_limit

acled_requests

type

email

<p class="slate-p " >Get items for given module and workspace</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Get items

The unique identifier of the item for which the coordinates are being retrieved.

The type of item for which the coordinates are being retrieved.

sort

page

limit

current_page

total_pages

total_results

<p class="slate-p " >Gets item based on workspace id, module type and item id.</p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Gets item based on workspace id, module type and item id.

Get item

The unique identifier for the workspace that contains the item.

The type of item for which coordinates are being retrieved.

The unique identifier for the item within the specified workspace.

item_id

location

person

date_created

notes

is_favorite

photo_id

user_id

photo_url

timestamp

coordinates

search_request

people

faces

<p class="slate-p " >Gets all workspaces associated with user.</p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Gets all workspaces associated with user.

Get Workspaces

List of workspaces and associated coordinates

<p class="slate-p " >Search</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Telegram</div></li><li class="slate-li " ><div style="position:relative">Twitter</div></li><li class="slate-li " ><div style="position:relative">Instagram</div></li><li class="slate-li " ><div style="position:relative">Threads</div></li><li class="slate-li " ><div style="position:relative">Youtube</div></li><li class="slate-li " ><div style="position:relative">Tiktok</div></li></ul><p class="slate-p " >based on hashtag</p><p class="slate-p " ></p>

Sections