Welcome to the company_dns!

You're either running this as your own instance, perhaps in docker, or access the Mediumroast, Inc. hosted instance of the company_dns.

The company_dns is meant to act like the domain naming service but for company information. Today data from Wikipedia, EDGAR, and the USA Standard Industry Classification maintained by OSHA is combined to help users obtain key firmographical information about companies.

Available endpoints and descriptions by version

Endpoints require that strings passed in are URL encoded. For example, a space should be encoded as %20. Should the call succeed a JSON document is returned with a status code of 200. If the call fails a JSON document is returned with a status code other than 200. The JSON document will contain a message field with a description of the error.

V3.0

Version 3.0 of the company_dns is the latest version and makes changes to the path structure for its endpoints. Notably "na" is added signifying North America meaning that results will be scoped to data sources only from North America. Additionally, "global" is added signfying that the related endpoint will respond with global results. As additional regionally specific data sources are added to the company_dns, the path structure will be updated to reflect the new data sources.

V2.0

Version 2.0 of the company_dns is the previous version and is still available for use. The path structure for endpoints in this version is different from V3.0. The V2.0 endpoints are not scoped to any specific region and will return results from all available data sources. While V2.0 is still available, it is recommended to use V3.0 for new development.

Use curl to talk to the company_dns

Gather information on "IBM" from both Wikipedia and EDGAR data sources from a company_dns instance on localhost. Search for "oil" in the SIC descriptions from a company_dns instance on Mediumroast's company_dns.

Helpful links for company_dns

  1. Issues on github
  2. Source repository
  3. Licensed under the Apache 2.0 open source license. This software is provided as is and without warranty or guarantee of support.

Execute RESTful calls to either a locally hosted company_dns or one hosted by Mediumroast.