Help for the company_dns
The company_dns acts as a "domain name service" for company information, providing structured access to firmographic data from multiple sources. This tool allows you to:
- Search industry codes across multiple classification systems
- Retrieve company information from Wikipedia and EDGAR
- Access standardized data through a consistent RESTful API
- Compare industry classifications across different international standards
Deployment Options
Self-Hosted
Running as your own instance, perhaps in Docker
http://localhost:8000
What is company_dns?
The company_dns integrates data from multiple sources to provide comprehensive firmographic information about companies. Currently, it combines:
Industry Classifications
- US SIC (Standard Industry Classification)
- UK SIC (United Kingdom Standard Industrial Classification)
- ISIC (International Standard Industrial Classification)
- EU NACE (European Classification of Economic Activities)
- Japan SIC (Japan Standard Industrial Classification)
Company Data
- Wikipedia - General company information
- EDGAR - SEC filings and financial data
- Merged sources - Combined firmographic data
API Versions
The company_dns API is available in two versions:
V3.0 (Current)
The latest version with regional path structure:
/V3.0/na/...- North America specific endpoints/V3.0/uk/...- United Kingdom specific endpoints/V3.0/eu/...- European Union specific endpoints/V3.0/japan/...- Japan specific endpoints/V3.0/international/...- International standards/V3.0/global/...- Global data across regions
V2.0 (Legacy)
The previous version with simpler path structure:
/V2.0/...- All endpoints without regional specificity
Note: V2.0 is maintained for backwards compatibility but new development should use V3.0
API Documentation
All endpoints return JSON responses. If a request is successful, a status code of 200 is returned. Otherwise, an error code and message are provided in the response.
Note: All query parameters should be URL-encoded. For example, spaces should be encoded as %20.
Response Format
{
"code": 200, // HTTP status code
"message": "Success", // Status message
"total": 5, // Total number of results
"data": {
"results": [ // Array of result objects
{
// Result properties depend on the endpoint
}
]
}
}Using the Industry Code Explorer
The Industry Code Explorer allows you to search across multiple industry classification systems using keywords. This is useful for finding comparable industry codes across different standards.
Step 1: Enter a Search Term
Enter an industry keyword in the search box (e.g., "oil", "manufacturing", "retail").
Step 2: Filter Results
Use the checkboxes on the left to filter results by classification system:
- US SIC - United States Standard Industrial Classification
- UK SIC - United Kingdom Standard Industrial Classification
- EU NACE - European Classification of Economic Activities
- ISIC - International Standard Industrial Classification
- Japan SIC - Japan Standard Industrial Classification
Step 3: Explore Results
Each result shows:
- Classification system badge
- Industry description
- Industry code
- Additional details when available
Pro Tip
Use broader terms for more comprehensive results. For example, search for "computer" instead of "computer manufacturing" to find all related industries.
Using the Query Explorer
The Query Explorer provides a user-friendly interface to test API endpoints without writing code. This is useful for exploring available data and testing queries before implementing them in your application.
Step 1: Select Host
Choose between a local instance (localhost:8000) or the Mediumroast hosted instance (company-dns.mediumroast.io).
Step 2: Select Endpoint
Choose the API endpoint you want to query from the dropdown menu.
Step 3: Enter Query
Enter your search term or identifier in the query field.
Example Queries:
- Company name:
IBM,Apple,Google - Industry keyword:
oil,manufacturing,retail - SIC code:
7371,2911
Step 4: View Results
The query URL and JSON response will appear below the form.
Code Examples
Using curl
Get Company Information (US)
curl http://localhost:8000/V3.0/na/company/merged/firmographics/IBMSearch US SIC Descriptions
Search EU NACE Descriptions
curl http://localhost:8000/V3.0/eu/sic/description/manufacturingSearch Across All Industry Classifications
curl http://localhost:8000/V3.0/global/sic/description/oilUsing JavaScript (Fetch API)
Get Company Information
fetch('http://localhost:8000/V3.0/global/company/merged/firmographics/Apple')
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));Search Industry Codes
// URL-encode the search term
const searchTerm = encodeURIComponent('software');
fetch(`http://localhost:8000/V3.0/global/sic/description/${searchTerm}`)
.then(response => response.json())
.then(data => {
if (data.code === 200) {
console.log(`Found ${data.total} results`);
data.data.results.forEach(result => {
console.log(`${result.source_type}: ${result.code} - ${result.description}`);
});
}
})
.catch(error => console.error('Error:', error));Using Python (Requests)
Get Company Information
import requests
import json
response = requests.get('http://localhost:8000/V3.0/global/company/merged/firmographics/Microsoft')
data = response.json()
if data['code'] == 200:
print(json.dumps(data, indent=2))Compare Industry Classifications
import requests
import urllib.parse
# Search term
term = urllib.parse.quote('retail')
# Get results from multiple classification systems
us_sic = requests.get(f'http://localhost:8000/V3.0/na/sic/description/{term}').json()
uk_sic = requests.get(f'http://localhost:8000/V3.0/uk/sic/description/{term}').json()
eu_nace = requests.get(f'http://localhost:8000/V3.0/eu/sic/description/{term}').json()
# Print comparison
print(f"US SIC results: {us_sic['total']}")
print(f"UK SIC results: {uk_sic['total']}")
print(f"EU NACE results: {eu_nace['total']}")Query Explorer
API Request
Response
Response Data
Quick Tips
Example Queries
Industry Code Explorer
Search across multiple industry classification systems to find and compare codes for various business activities. This tool helps you identify equivalent categories across different standards.