Name2Domain API Documentation (v1)

The Name2Domain API enables you to convert company names in your CRM or database into accurate company websites and domains.

Calling the API

V1 of the API is hosted at https://www.name2domain.com/api/v1. All calls use this URL as the base.

Authentication

Name2Domain uses token-based authentication. If you're logged into your Name2Domain account, you'll see your API key below.

Simply include key as a query parameter or a header parameter in your queries, like this:

https://www.name2domain.com/api/v1/convert?key=<<log in to see your key>>&company=tesla
.

If you don't include an API key or use the wrong one, Name2Domain will respond with a 401 authorization error.

Status and Error Codes

Here are the most common HTTP status codes you may receive from our API and what they mean.

One-off Convert Company Name

Convert company name to domain

Given a company name string this method will find and return the best website domain.

Example

GET https://www.name2domain.com/api/v1/convert?key=<<log in to see your key>>&company=tesla

Result

{
  "status": "SUCCESS",
  "message": "Converted company name.",
  "data": {
    "domain": "tesla.com",
    "title": "Electric Cars, Solar Panels & Clean Energy Storage  | Tesla",
    "description": "Tesla is accelerating the world's transition to sustainable energy with electric cars, solar panels and integrated renewable energy solutions for homes and businesses.",
    "keywords": "Tesla, Electric vehicles, EV, Electric cars, Elon Musk, Tesla news , Sustainable energy, Autopilot, Supercharger , Model S, Model X, Model 3"
  }
}

Bulk Convert Company Names

Batches

List batches

This is the index call for your batches. Batches store the bulk company data you submit for processing. A status attibute on the batch will tell you whether the batch is still processing or finished.

Example

GET https://www.name2domain.com/api/v1/batches?key=<<log in to see your key>>

Result

{
  "status": "SUCCESS",
  "message": "Loaded all batches.",
  "data": [
    {
      "id": 24,
      "user_id": 1,
      "name": "Marketing batch A",
      "created_at": "2020-02-04T23:38:06.876Z",
      "updated_at": "2020-02-04T23:38:06.955Z",
      "status": "ready"
    }
  ],
  "last_page": true,
  "total_count": 1
}

Create a batch

Add a batch of company names to process on your account.

Parameters

key Your API key required
name A name to identify or describe your batch required
data Array of JSON-formatted companies. Each item must include a company key. required
webhook_url Fully-formed URL to accept a POST request containing the batch attributes when the batch status changes to finished. optional

Example

POST https://www.emailfinder.io/api/v1/batches

Result

{
  "status": "SUCCESS",
  "message": "Created batch.",
  "data": {
    "id": 24,
    "user_id": 1,
    "name": "Marketing batch A",
    "created_at": "2020-02-04T23:38:06.876Z",
    "updated_at": "2020-02-04T23:38:06.955Z",
    "status": "ready"
  }
}

Export a batch

This is the index call for the data in a batch. To export all your data, you must do so on a batch-by-batch basis.

Example

GET https://www.emailfinder.io/api/v1/batches/<batch_id>?key=<<log in to see your key>>

Result

{
  "status": "SUCCESS",
  "message": "Loaded data.",
  "data": [
    {
      "name": "scripted",
      "converted_at": "2020-02-16T18:55:50.688Z",
      "domain": "scripted.com"
    },
    {
      "name": "trackjobchanges.com",
      "converted_at": "2020-02-16T18:55:51.158Z",
      "domain": "trackjobchanges.com"
    },
    {
      "name": "jsx jetsuite",
      "converted_at": "2020-02-16T18:55:52.022Z",
      "domain": "jetsuite.com"
    }
  ]
}

© 2020 Toofr LLC. All rights reserved.