Big Media Scraper API Documentation

BMS API documentation

First, go to the /settings page and set your API key.

Authentication is needed for all API services, except for the ping service. To authenticate provide your email and your API key as HTTP Basic Auth headers. Examples for each service are provided below.

Ping service at /api/v1.0/ping

A simple ping-like service for testing purposes. Example:

$ curl
					{"ping": "pong"}

					$ curl --user EMAIL:API_KEY --data ""
					{"authenticated_user": "EMAIL", "ping": "pong"}


Return "pong". For testing if connection to API works.

Response: json


Return email of authenticated user. For testing if auth works.

Response: json

Job service at /api/v1.0/jobs/{job_id}

A service for getting a single Job. Example:

$ curl --user EMAIL:API_KEY
					    "id": 1,
					    "sources": ["flickr", "youtube"],
					    "richtextify": ["bold_keywords", "headings", "italic_sentence"],
					    "flickr_next_page_token": "2",
					    "youtube_next_page_token": "CDIQAA",
					    "state": "success",
					    "positions": ["after_first", "before_last"],
					    "keywords": ["green energy"],
					    "articles": [...],


Return the Job for a given job_id.

Response: json

Jobs service at /api/v1.0/jobs

A service for creating Jobs. Example:

$ curl --user EMAIL:API_KEY -H "Content-Type: application/json"
					    --data '{"keywords":["dogs","cats"],"articles":["first","second"]}'
					{"id": 1}


values in the body
  • file_upload : FileData, optional
  • keywords : List, required
  • sources : List, optional
  • positions : List, optional
  • richtextify : List, optional
  • articles : Set, required
  • flickr_next_page_token : String, optional
  • youtube_next_page_token : String, optional

Create a new Job.

Param sources:flickr, youtube
Param positions:
 before_first, after_first, before_last, after_last
Param richtextify:
 bold_keywords, italic_sentence, headers

Response: json