Skip to content

GET all Sources

Ksenyia edited this page Feb 1, 2017 · 8 revisions

Getting list of the sources limited by 2 parameters "limit" and "skip". To get the whole list, please set limit=0 and skip=50000 (Resource URI: 'sources/0/50000')

Resource URI

sources/{limit}/{skip}

Resource Properties

Parameter Description
limit It limit the search. Default is 50. Eg. sources/50/0
skip Offset of next page result. Default is 0. Eg. sources/50/0

Response Attribute

{
   count: Integer,
   errorList: Array,
   sources: [
      {
          _id: String,
          source_name: String,
          source_type_id: {
              _id: String,
              source_type_authority: String,
              source_type_display:  Boolean (true or false),
              source_type_id: String,
              source_type_name: String,
          },
          source_url: String,
          source_archive_url: String,
          retrieve_date: Date,
          source_date: Date
     }
   ]
}

HTTP GET

Default Request

curl -GET http://end-point-uri/sources/50/0

Response

HTTP Status Code 200

{
   count: 74,
   errorList: [],
   sources: [
      {
          _id: "571654330ef3fc0100672a6e",
          source_name: "2015 Total mandatory disclosure",
          source_type_id: {
              _id: "585bb9088bb3aa000f211565",
              source_type_authority: "non-authoritative",
              source_type_display: false,
              source_type_id: "wikipedia",
              source_type_name: "Wikipedia",
          },
          source_url: "https://www.sec.gov/Archives/edgar/data/879764/000119312516506029/d83747d20f.htm",
          source_archive_url: "",
          retrieve_date: "2016-04-10T00:00:00.000Z",
          source_date: "2016-04-10T00:00:00.000Z"
      },
      ...
   ]
}
Clone this wiki locally