orb.json

gistfile1.txt

"optional": [
  { "name": "limit", "type": "Number", "description": "Number of results in response (in a page)." },
  { "name": "offset", "type": "Number", "description": "Number of results to skip (to get a particular page)." },
  { "name": "entity_type", "type": "String", "enumeration": [
    "company",
    "branch"
  ]},
  { "name": "parent_orb_num", "type": "String" },
  { "name": "ultimate_parent_orb_num", "type": "String" },
  { "name": "industry", "type": "String", "description": "Company’s industry." },
  { "type": "City", "description": "Filter by city" },
  { "type": "State", "description": "Filter by state" },
  { "type": "PostCode", "description": "Filter by post code" },
  { "type": "Country", "description": "Filter by country" },
  { "name": "employees", "type": "String", "description": "employees count range", "enumeration": [
    "any",
    "1-10",
    "10-50",
    "50-200",
    "200-500",
    "500-1k",
    "1k-5k",
    "5k-10k",
    "10k"
  ]},
  { "name": "revenue", "type": "String", "description": "revenue range", "enumeration": [
    "any",
    "0-1m",
    "1m-10m",
    "10m-50m",
    "50m-100m",
    "100m-200m",
    "200m-1b",
    "1b"
  ]},
  { "name": "techs", "type": "String", "description": "Filter by techonologies installed." },
  { "name": "tech_categories", "type": "String", "description": "Filter by techonologies classes." },
  { "name": "naics_codes", "type": "String", "description": "Filter by NAICS code" },
  { "name": "sic_codes", "type": "String", "description": "Filter by SIC code" },
  { "name": "rankings", "type": "String", "description": "Get companies from companies ranked lists, such as Forbes, Fortune or Inc.5000." },
  { "name": "importance_score", "type": "String", "description": "Filter companies by importances classes A, B or C" },
  { "name": "cik", "type": "String", "description": "Filter by CIK (The Central Index Key from SEC)." },
  { "name": "cusip", "type": "String", "description": "Filter by CUSIP (https://en.wikipedia.org/wiki/CUSIP)." },
  { "name": "ticker", "type": "String", "description": "Filter by stock exchange ticker." },
  { "name": "exchange", "type": "String", "description": "Filter by stock exchange." },
  { "name": "show_full_profile", "type": "Boolean", "description": "Embed full company profile" },
  { "name": "orb_num", "type": "String", "description": "Orb Number of the company." }
]