Firmograph API

API documentation

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.8851fb9336c9.js"></script>
<script src="/api/schema.js"></script>

# Install the Python client library
$ pip install coreapi

company

list

GET /api/company/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`address`	Address of company to search for (whole address string)
`name`	Name of company to search for

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action company list -p limit=... -p offset=... -p address=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["company", "list"]
var params = {
    limit: ...,
    offset: ...,
    address: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["company", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "address": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/company/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this Company.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`address`	Address of company to search for (whole address string)
`name`	Name of company to search for

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action company read -p id=... -p address=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["company", "read"]
var params = {
    id: ...,
    address: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["company", "read"]
params = {
    "id": ...,
    "address": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

domain

list

GET /api/domain/

List domains

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`country`	Domain country

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action domain list -p limit=... -p offset=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["domain", "list"]
var params = {
    limit: ...,
    offset: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["domain", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/domain/

Create domain

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`value` required	Domain name
`source` required	(`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`httperr`	(`none`, `timeout`, `dns_lookup`, `connection_lost`, `connection_refused`, `response_never_received`, `ignore_request`, `connection_done`, `accepted`, `no_data`, `bad_request`, `unauthorized`, `forbidden`, `not_found`, `method_not_allowed`, `server_error`, `bad_gateway`, `service_unavailable`, `gateway_timeout`, `other`)
`crawl_status`	(`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	(`none`, `paired`, `non_paired`)
`protocol`	(`unknown`, `https`, `http`)
`jobs`	(`no_career_links`, `no_vacancies`, `vacancies`, `unknown`)
`extra_contact_urls`	Extra URLs to scrape from
`country`
`date_checked`
`www_prefix`	Default adress is www.domain.tld
`date_jobs_checked`
`confirmed_values`
`technologies`
`ip`
`pages_to_download`	Max pages to download during full crawl. If NONE is set `VISIT_PAGES_PER_DOMAIN` scrapy setting value is used
`path_sitemap`

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action domain create -p value=... -p source=... -p httperr=... -p crawl_status=... -p merk_status=... -p protocol=... -p jobs=... -p extra_contact_urls=... -p country=... -p date_checked=... -p www_prefix=... -p date_jobs_checked=... -p confirmed_values=... -p technologies=... -p ip=... -p pages_to_download=... -p path_sitemap=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["domain", "create"]
var params = {
    value: ...,
    source: ...,
    httperr: ...,
    crawl_status: ...,
    merk_status: ...,
    protocol: ...,
    jobs: ...,
    extra_contact_urls: ...,
    country: ...,
    date_checked: ...,
    www_prefix: ...,
    date_jobs_checked: ...,
    confirmed_values: ...,
    technologies: ...,
    ip: ...,
    pages_to_download: ...,
    path_sitemap: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["domain", "create"]
params = {
    "value": ...,
    "source": ...,
    "httperr": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "protocol": ...,
    "jobs": ...,
    "extra_contact_urls": ...,
    "country": ...,
    "date_checked": ...,
    "www_prefix": ...,
    "date_jobs_checked": ...,
    "confirmed_values": ...,
    "technologies": ...,
    "ip": ...,
    "pages_to_download": ...,
    "path_sitemap": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/domain/{id}/

Retrieve data about domain

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`country`	Domain country

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action domain read -p id=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["domain", "read"]
var params = {
    id: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["domain", "read"]
params = {
    "id": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/domain/{id}/

Update domain

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`country`	Domain country

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`value` required	Domain name
`source` required	(`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`httperr`	(`none`, `timeout`, `dns_lookup`, `connection_lost`, `connection_refused`, `response_never_received`, `ignore_request`, `connection_done`, `accepted`, `no_data`, `bad_request`, `unauthorized`, `forbidden`, `not_found`, `method_not_allowed`, `server_error`, `bad_gateway`, `service_unavailable`, `gateway_timeout`, `other`)
`crawl_status`	(`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	(`none`, `paired`, `non_paired`)
`protocol`	(`unknown`, `https`, `http`)
`jobs`	(`no_career_links`, `no_vacancies`, `vacancies`, `unknown`)
`extra_contact_urls`	Extra URLs to scrape from
`country`
`date_checked`
`www_prefix`	Default adress is www.domain.tld
`date_jobs_checked`
`confirmed_values`
`technologies`
`ip`
`pages_to_download`	Max pages to download during full crawl. If NONE is set `VISIT_PAGES_PER_DOMAIN` scrapy setting value is used
`path_sitemap`

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action domain update -p id=... -p value=... -p source=... -p httperr=... -p crawl_status=... -p merk_status=... -p protocol=... -p jobs=... -p extra_contact_urls=... -p country=... -p date_checked=... -p www_prefix=... -p date_jobs_checked=... -p confirmed_values=... -p technologies=... -p ip=... -p pages_to_download=... -p path_sitemap=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["domain", "update"]
var params = {
    id: ...,
    value: ...,
    source: ...,
    httperr: ...,
    crawl_status: ...,
    merk_status: ...,
    protocol: ...,
    jobs: ...,
    extra_contact_urls: ...,
    country: ...,
    date_checked: ...,
    www_prefix: ...,
    date_jobs_checked: ...,
    confirmed_values: ...,
    technologies: ...,
    ip: ...,
    pages_to_download: ...,
    path_sitemap: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["domain", "update"]
params = {
    "id": ...,
    "value": ...,
    "source": ...,
    "httperr": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "protocol": ...,
    "jobs": ...,
    "extra_contact_urls": ...,
    "country": ...,
    "date_checked": ...,
    "www_prefix": ...,
    "date_jobs_checked": ...,
    "confirmed_values": ...,
    "technologies": ...,
    "ip": ...,
    "pages_to_download": ...,
    "path_sitemap": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/domain/{id}/

Partially update domain

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`country`	Domain country

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`value`	Domain name
`source`	(`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`httperr`	(`none`, `timeout`, `dns_lookup`, `connection_lost`, `connection_refused`, `response_never_received`, `ignore_request`, `connection_done`, `accepted`, `no_data`, `bad_request`, `unauthorized`, `forbidden`, `not_found`, `method_not_allowed`, `server_error`, `bad_gateway`, `service_unavailable`, `gateway_timeout`, `other`)
`crawl_status`	(`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	(`none`, `paired`, `non_paired`)
`protocol`	(`unknown`, `https`, `http`)
`jobs`	(`no_career_links`, `no_vacancies`, `vacancies`, `unknown`)
`extra_contact_urls`	Extra URLs to scrape from
`country`
`date_checked`
`www_prefix`	Default adress is www.domain.tld
`date_jobs_checked`
`confirmed_values`
`technologies`
`ip`
`pages_to_download`	Max pages to download during full crawl. If NONE is set `VISIT_PAGES_PER_DOMAIN` scrapy setting value is used
`path_sitemap`

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action domain partial_update -p id=... -p value=... -p source=... -p httperr=... -p crawl_status=... -p merk_status=... -p protocol=... -p jobs=... -p extra_contact_urls=... -p country=... -p date_checked=... -p www_prefix=... -p date_jobs_checked=... -p confirmed_values=... -p technologies=... -p ip=... -p pages_to_download=... -p path_sitemap=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["domain", "partial_update"]
var params = {
    id: ...,
    value: ...,
    source: ...,
    httperr: ...,
    crawl_status: ...,
    merk_status: ...,
    protocol: ...,
    jobs: ...,
    extra_contact_urls: ...,
    country: ...,
    date_checked: ...,
    www_prefix: ...,
    date_jobs_checked: ...,
    confirmed_values: ...,
    technologies: ...,
    ip: ...,
    pages_to_download: ...,
    path_sitemap: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["domain", "partial_update"]
params = {
    "id": ...,
    "value": ...,
    "source": ...,
    "httperr": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "protocol": ...,
    "jobs": ...,
    "extra_contact_urls": ...,
    "country": ...,
    "date_checked": ...,
    "www_prefix": ...,
    "date_jobs_checked": ...,
    "confirmed_values": ...,
    "technologies": ...,
    "ip": ...,
    "pages_to_download": ...,
    "path_sitemap": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)

domain_content

list

GET /api/domain_content/

List text content of domains

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`country`	Domain country

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action domain_content list -p limit=... -p offset=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["domain_content", "list"]
var params = {
    limit: ...,
    offset: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["domain_content", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/domain_content/{id}/

Retrieve text content of domain

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this Domain.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`country`	Domain country

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action domain_content read -p id=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["domain_content", "read"]
var params = {
    id: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["domain_content", "read"]
params = {
    "id": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)

exports

job_positions > list

GET /api/exports/job_positions

export job positions for CZ/SK domains

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action exports job_positions list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["exports", "job_positions &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["exports", "job_positions &gt; list"]
result = client.action(schema, action)

for_crawler

cursor > list

GET /api/for_crawler/cursor/

list domains (only fields necessary for crawler are returned)

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cursor`	The pagination cursor value.
`limit`	Number of results to return per page.
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`has_emails`	Only domains with emails (`has_emails=true`), or without emails (`has_emails=false`). Leave out this parameter to include both.
`has_phones`	Only domains with phones (`has_phones=true`), or without phones (`has_phones=false`). Leave out this parameter to include both.
`httperr`	HTTP error (`none`, `timeout`, `dns_lookup`, `connection_lost`, `connection_refused`, `response_never_received`, `ignore_request`, `connection_done`, `accepted`, `no_data`, `bad_request`, `unauthorized`, `forbidden`, `not_found`, `method_not_allowed`, `server_error`, `bad_gateway`, `service_unavailable`, `gateway_timeout`, `other`)
`contact_urls`	Whether to include contact links in the response
`is_subdomain`	Set to `true` to select only domains with `is_subdomain=True`.
`country`	Domain country

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action for_crawler cursor list -p cursor=... -p limit=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p has_emails=... -p has_phones=... -p httperr=... -p contact_urls=... -p is_subdomain=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["for_crawler", "cursor &gt; list"]
var params = {
    cursor: ...,
    limit: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    has_emails: ...,
    has_phones: ...,
    httperr: ...,
    contact_urls: ...,
    is_subdomain: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["for_crawler", "cursor &gt; list"]
params = {
    "cursor": ...,
    "limit": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "has_emails": ...,
    "has_phones": ...,
    "httperr": ...,
    "contact_urls": ...,
    "is_subdomain": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)

domain > list

GET /api/for_crawler/domain/

list domains (only fields necessary for crawler are returned)

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cursor`	The pagination cursor value.
`limit`	Number of results to return per page.
`date_checked`	Datetime of the last time domain was crawled. Use `date_checked_after='...'` and/or `date_checked_before='...'`
`date_created`	Datetime of the domain insertion into DB. Use `date_created_after='...'` and/or `date_created_before='...'`
`source`	Source of domain (`user_search`, `linkedin`, `test`, `redirect`, `merk`, `usa_b2b`, `ssl_cert`, `sk`)
`crawl_status`	Crawl status (`none`, `unknown`, `success`, `no_contacts`, `http_error`, `parking`, `redirect`, `black_redir`, `robots_txt_disallow_all`, `cannot_be_displayed_err`, `default_page`, `no_contacts_need_js`)
`merk_status`	MERK status (`none`, `paired`, `non_paired`)
`value`	Domain name
`ordering`	Ordering of results (for multiple ordering use values separated by a coma)
`has_emails`	Only domains with emails (`has_emails=true`), or without emails (`has_emails=false`). Leave out this parameter to include both.
`has_phones`	Only domains with phones (`has_phones=true`), or without phones (`has_phones=false`). Leave out this parameter to include both.
`httperr`	HTTP error (`none`, `timeout`, `dns_lookup`, `connection_lost`, `connection_refused`, `response_never_received`, `ignore_request`, `connection_done`, `accepted`, `no_data`, `bad_request`, `unauthorized`, `forbidden`, `not_found`, `method_not_allowed`, `server_error`, `bad_gateway`, `service_unavailable`, `gateway_timeout`, `other`)
`contact_urls`	Whether to include contact links in the response
`is_subdomain`	Set to `true` to select only domains with `is_subdomain=True`.
`country`	Domain country

# Load the schema document
$ coreapi get https://app.firmograph.io/api/

# Interact with the API endpoint
$ coreapi action for_crawler domain list -p cursor=... -p limit=... -p date_checked=... -p date_created=... -p source=... -p crawl_status=... -p merk_status=... -p value=... -p ordering=... -p has_emails=... -p has_phones=... -p httperr=... -p contact_urls=... -p is_subdomain=... -p country=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["for_crawler", "domain &gt; list"]
var params = {
    cursor: ...,
    limit: ...,
    date_checked: ...,
    date_created: ...,
    source: ...,
    crawl_status: ...,
    merk_status: ...,
    value: ...,
    ordering: ...,
    has_emails: ...,
    has_phones: ...,
    httperr: ...,
    contact_urls: ...,
    is_subdomain: ...,
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://app.firmograph.io/api/")

# Interact with the API endpoint
action = ["for_crawler", "domain &gt; list"]
params = {
    "cursor": ...,
    "limit": ...,
    "date_checked": ...,
    "date_created": ...,
    "source": ...,
    "crawl_status": ...,
    "merk_status": ...,
    "value": ...,
    "ordering": ...,
    "has_emails": ...,
    "has_phones": ...,
    "httperr": ...,
    "contact_urls": ...,
    "is_subdomain": ...,
    "country": ...,
}
result = client.action(schema, action, params=params)