Hunter's API Documentation

AccountInformation

accountInformation

This API endpoint enables you to get information regarding your Hunter account at any time. This call is free.


/account

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/hunter/v2/account?api_key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationApi;

import java.io.File;
import java.util.*;

public class AccountInformationApiExample {

    public static void main(String[] args) {
        
        AccountInformationApi apiInstance = new AccountInformationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        try {
            inline_response_200_4 result = apiInstance.accountInformation(apiecoKey, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationApi#accountInformation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountInformationApi;

public class AccountInformationApiExample {

    public static void main(String[] args) {
        AccountInformationApi apiInstance = new AccountInformationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        try {
            inline_response_200_4 result = apiInstance.accountInformation(apiecoKey, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationApi#accountInformation");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apiKey = apiKey_example; // Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)

AccountInformationApi *apiInstance = [[AccountInformationApi alloc] init];

[apiInstance accountInformationWith:apiecoKey
    apiKey:apiKey
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HuntersApiDocumentation = require('hunters_api_documentation');

var api = new HuntersApiDocumentation.AccountInformationApi()

var apiecoKey = apiecoKey_example; // {String} 

var apiKey = apiKey_example; // {String} Don't change the value


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountInformation(apiecoKey, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountInformationExample
    {
        public void main()
        {
            
            var apiInstance = new AccountInformationApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apiKey = apiKey_example;  // String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)

            try
            {
                inline_response_200_4 result = apiInstance.accountInformation(apiecoKey, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountInformationApi.accountInformation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AccountInformationApi();
$apiecoKey = apiecoKey_example; // String | 
$apiKey = apiKey_example; // String | Don't change the value

try {
    $result = $api_instance->accountInformation($apiecoKey, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationApi->accountInformation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountInformationApi;

my $api_instance = WWW::SwaggerClient::AccountInformationApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apiKey = apiKey_example; # String | Don't change the value

eval { 
    my $result = $api_instance->accountInformation(apiecoKey => $apiecoKey, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountInformationApi->accountInformation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountInformationApi()
apiecoKey = apiecoKey_example # String | 
apiKey = apiKey_example # String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)

try: 
    api_response = api_instance.account_information(apiecoKey, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationApi->accountInformation: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
api_key*
String
Don't change the value
Required

Responses

Status: 200 - Successful


DomainSearch

domainSearch

One key feature of Hunter is to search all the email addresses corresponding to one website. You give one domain name and it returns all the email addresses using this domain name found on the internet.


/domain-search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/hunter/v2/domain-search?api_key=&domain=&company=&limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomainSearchApi;

import java.io.File;
import java.util.*;

public class DomainSearchApiExample {

    public static void main(String[] args) {
        
        DomainSearchApi apiInstance = new DomainSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
        String company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
        BigDecimal limit = 8.14; // BigDecimal | Specifies the max number of email addresses to return. The default is 10.
        BigDecimal offset = 8.14; // BigDecimal | Specifies the number of email addresses to skip. The default is 0.
        try {
            inline_response_200 result = apiInstance.domainSearch(apiecoKey, apiKey, domain, company, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainSearchApi#domainSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomainSearchApi;

public class DomainSearchApiExample {

    public static void main(String[] args) {
        DomainSearchApi apiInstance = new DomainSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
        String company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
        BigDecimal limit = 8.14; // BigDecimal | Specifies the max number of email addresses to return. The default is 10.
        BigDecimal offset = 8.14; // BigDecimal | Specifies the number of email addresses to skip. The default is 0.
        try {
            inline_response_200 result = apiInstance.domainSearch(apiecoKey, apiKey, domain, company, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainSearchApi#domainSearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apiKey = apiKey_example; // Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
String *domain = domain_example; // Domain name from which you want to find the email addresses. For example, "stripe.com".
String *company = company_example; // The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
BigDecimal *limit = 8.14; // Specifies the max number of email addresses to return. The default is 10. (optional)
BigDecimal *offset = 8.14; // Specifies the number of email addresses to skip. The default is 0. (optional)

DomainSearchApi *apiInstance = [[DomainSearchApi alloc] init];

[apiInstance domainSearchWith:apiecoKey
    apiKey:apiKey
    domain:domain
    company:company
    limit:limit
    offset:offset
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HuntersApiDocumentation = require('hunters_api_documentation');

var api = new HuntersApiDocumentation.DomainSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apiKey = apiKey_example; // {String} Don't change the value

var domain = domain_example; // {String} Domain name from which you want to find the email addresses. For example, "stripe.com".

var company = company_example; // {String} The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.

var opts = { 
  'limit': 8.14, // {BigDecimal} Specifies the max number of email addresses to return. The default is 10.
  'offset': 8.14 // {BigDecimal} Specifies the number of email addresses to skip. The default is 0.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.domainSearch(apiecoKey, apiKey, domain, company, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class domainSearchExample
    {
        public void main()
        {
            
            var apiInstance = new DomainSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apiKey = apiKey_example;  // String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
            var domain = domain_example;  // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
            var company = company_example;  // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
            var limit = 8.14;  // BigDecimal | Specifies the max number of email addresses to return. The default is 10. (optional) 
            var offset = 8.14;  // BigDecimal | Specifies the number of email addresses to skip. The default is 0. (optional) 

            try
            {
                inline_response_200 result = apiInstance.domainSearch(apiecoKey, apiKey, domain, company, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomainSearchApi.domainSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DomainSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apiKey = apiKey_example; // String | Don't change the value
$domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
$company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
$limit = 8.14; // BigDecimal | Specifies the max number of email addresses to return. The default is 10.
$offset = 8.14; // BigDecimal | Specifies the number of email addresses to skip. The default is 0.

try {
    $result = $api_instance->domainSearch($apiecoKey, $apiKey, $domain, $company, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomainSearchApi->domainSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomainSearchApi;

my $api_instance = WWW::SwaggerClient::DomainSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apiKey = apiKey_example; # String | Don't change the value
my $domain = domain_example; # String | Domain name from which you want to find the email addresses. For example, "stripe.com".
my $company = company_example; # String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
my $limit = 8.14; # BigDecimal | Specifies the max number of email addresses to return. The default is 10.
my $offset = 8.14; # BigDecimal | Specifies the number of email addresses to skip. The default is 0.

eval { 
    my $result = $api_instance->domainSearch(apiecoKey => $apiecoKey, apiKey => $apiKey, domain => $domain, company => $company, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomainSearchApi->domainSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DomainSearchApi()
apiecoKey = apiecoKey_example # String | 
apiKey = apiKey_example # String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
domain = domain_example # String | Domain name from which you want to find the email addresses. For example, "stripe.com".
company = company_example # String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
limit = 8.14 # BigDecimal | Specifies the max number of email addresses to return. The default is 10. (optional)
offset = 8.14 # BigDecimal | Specifies the number of email addresses to skip. The default is 0. (optional)

try: 
    api_response = api_instance.domain_search(apiecoKey, apiKey, domain, company, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomainSearchApi->domainSearch: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
api_key*
String
Don't change the value
Required
domain*
String
Domain name from which you want to find the email addresses. For example, "stripe.com".
Required
company*
String
The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
Required
limit
BigDecimal
Specifies the max number of email addresses to return. The default is 10.
offset
BigDecimal
Specifies the number of email addresses to skip. The default is 0.

Responses

Status: 200 - Successful


EmailCount

emailCount

This API endpoint allows you to know how many email addresses we have for one domain or for one company. It's free and doesn't require authentication.


/email-count

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/hunter/v2/email-count?api_key=&domain=&company=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EmailCountApi;

import java.io.File;
import java.util.*;

public class EmailCountApiExample {

    public static void main(String[] args) {
        
        EmailCountApi apiInstance = new EmailCountApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
        String company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
        BigDecimal type = 8.14; // BigDecimal | Get the count of only personal or generic email addresses.
        try {
            inline_response_200_3 result = apiInstance.emailCount(apiecoKey, apiKey, domain, company, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailCountApi#emailCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EmailCountApi;

public class EmailCountApiExample {

    public static void main(String[] args) {
        EmailCountApi apiInstance = new EmailCountApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
        String company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
        BigDecimal type = 8.14; // BigDecimal | Get the count of only personal or generic email addresses.
        try {
            inline_response_200_3 result = apiInstance.emailCount(apiecoKey, apiKey, domain, company, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailCountApi#emailCount");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apiKey = apiKey_example; // Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
String *domain = domain_example; // Domain name from which you want to find the email addresses. For example, "stripe.com".
String *company = company_example; // The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
BigDecimal *type = 8.14; // Get the count of only personal or generic email addresses. (optional)

EmailCountApi *apiInstance = [[EmailCountApi alloc] init];

[apiInstance emailCountWith:apiecoKey
    apiKey:apiKey
    domain:domain
    company:company
    type:type
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HuntersApiDocumentation = require('hunters_api_documentation');

var api = new HuntersApiDocumentation.EmailCountApi()

var apiecoKey = apiecoKey_example; // {String} 

var apiKey = apiKey_example; // {String} Don't change the value

var domain = domain_example; // {String} Domain name from which you want to find the email addresses. For example, "stripe.com".

var company = company_example; // {String} The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.

var opts = { 
  'type': 8.14 // {BigDecimal} Get the count of only personal or generic email addresses.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emailCount(apiecoKey, apiKey, domain, company, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class emailCountExample
    {
        public void main()
        {
            
            var apiInstance = new EmailCountApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apiKey = apiKey_example;  // String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
            var domain = domain_example;  // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
            var company = company_example;  // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
            var type = 8.14;  // BigDecimal | Get the count of only personal or generic email addresses. (optional) 

            try
            {
                inline_response_200_3 result = apiInstance.emailCount(apiecoKey, apiKey, domain, company, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailCountApi.emailCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EmailCountApi();
$apiecoKey = apiecoKey_example; // String | 
$apiKey = apiKey_example; // String | Don't change the value
$domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
$company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
$type = 8.14; // BigDecimal | Get the count of only personal or generic email addresses.

try {
    $result = $api_instance->emailCount($apiecoKey, $apiKey, $domain, $company, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailCountApi->emailCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EmailCountApi;

my $api_instance = WWW::SwaggerClient::EmailCountApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apiKey = apiKey_example; # String | Don't change the value
my $domain = domain_example; # String | Domain name from which you want to find the email addresses. For example, "stripe.com".
my $company = company_example; # String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
my $type = 8.14; # BigDecimal | Get the count of only personal or generic email addresses.

eval { 
    my $result = $api_instance->emailCount(apiecoKey => $apiecoKey, apiKey => $apiKey, domain => $domain, company => $company, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EmailCountApi->emailCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EmailCountApi()
apiecoKey = apiecoKey_example # String | 
apiKey = apiKey_example # String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
domain = domain_example # String | Domain name from which you want to find the email addresses. For example, "stripe.com".
company = company_example # String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
type = 8.14 # BigDecimal | Get the count of only personal or generic email addresses. (optional)

try: 
    api_response = api_instance.email_count(apiecoKey, apiKey, domain, company, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailCountApi->emailCount: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
api_key*
String
Don't change the value
Required
domain*
String
Domain name from which you want to find the email addresses. For example, "stripe.com".
Required
company*
String
The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
Required
type
BigDecimal
Get the count of only personal or generic email addresses.

Responses

Status: 200 - Successful


EmailFinder

emailFinder

This API endpoint generates or retrieves the most likely email address from a domain name, a first name and a last name.


/email-finder

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/hunter/v2/email-finder?api_key=&domain=&company=&first_name=&last_name=&full_name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EmailFinderApi;

import java.io.File;
import java.util.*;

public class EmailFinderApiExample {

    public static void main(String[] args) {
        
        EmailFinderApi apiInstance = new EmailFinderApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
        String company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
        String firstName = firstName_example; // String | The person's first name. It doesn't need to be in lowercase.
        String lastName = lastName_example; // String | The person's last name. It doesn't need to be in lowercase.
        String fullName = fullName_example; // String | The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase.
        try {
            inline_response_200_1 result = apiInstance.emailFinder(apiecoKey, apiKey, domain, company, firstName, lastName, fullName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailFinderApi#emailFinder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EmailFinderApi;

public class EmailFinderApiExample {

    public static void main(String[] args) {
        EmailFinderApi apiInstance = new EmailFinderApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
        String company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
        String firstName = firstName_example; // String | The person's first name. It doesn't need to be in lowercase.
        String lastName = lastName_example; // String | The person's last name. It doesn't need to be in lowercase.
        String fullName = fullName_example; // String | The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase.
        try {
            inline_response_200_1 result = apiInstance.emailFinder(apiecoKey, apiKey, domain, company, firstName, lastName, fullName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailFinderApi#emailFinder");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apiKey = apiKey_example; // Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
String *domain = domain_example; // Domain name from which you want to find the email addresses. For example, "stripe.com".
String *company = company_example; // The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
String *firstName = firstName_example; // The person's first name. It doesn't need to be in lowercase. (optional)
String *lastName = lastName_example; // The person's last name. It doesn't need to be in lowercase. (optional)
String *fullName = fullName_example; // The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase. (optional)

EmailFinderApi *apiInstance = [[EmailFinderApi alloc] init];

[apiInstance emailFinderWith:apiecoKey
    apiKey:apiKey
    domain:domain
    company:company
    firstName:firstName
    lastName:lastName
    fullName:fullName
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HuntersApiDocumentation = require('hunters_api_documentation');

var api = new HuntersApiDocumentation.EmailFinderApi()

var apiecoKey = apiecoKey_example; // {String} 

var apiKey = apiKey_example; // {String} Don't change the value

var domain = domain_example; // {String} Domain name from which you want to find the email addresses. For example, "stripe.com".

var company = company_example; // {String} The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.

var opts = { 
  'firstName': firstName_example, // {String} The person's first name. It doesn't need to be in lowercase.
  'lastName': lastName_example, // {String} The person's last name. It doesn't need to be in lowercase.
  'fullName': fullName_example // {String} The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emailFinder(apiecoKey, apiKey, domain, company, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class emailFinderExample
    {
        public void main()
        {
            
            var apiInstance = new EmailFinderApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apiKey = apiKey_example;  // String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
            var domain = domain_example;  // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
            var company = company_example;  // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
            var firstName = firstName_example;  // String | The person's first name. It doesn't need to be in lowercase. (optional) 
            var lastName = lastName_example;  // String | The person's last name. It doesn't need to be in lowercase. (optional) 
            var fullName = fullName_example;  // String | The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase. (optional) 

            try
            {
                inline_response_200_1 result = apiInstance.emailFinder(apiecoKey, apiKey, domain, company, firstName, lastName, fullName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailFinderApi.emailFinder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EmailFinderApi();
$apiecoKey = apiecoKey_example; // String | 
$apiKey = apiKey_example; // String | Don't change the value
$domain = domain_example; // String | Domain name from which you want to find the email addresses. For example, "stripe.com".
$company = company_example; // String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
$firstName = firstName_example; // String | The person's first name. It doesn't need to be in lowercase.
$lastName = lastName_example; // String | The person's last name. It doesn't need to be in lowercase.
$fullName = fullName_example; // String | The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase.

try {
    $result = $api_instance->emailFinder($apiecoKey, $apiKey, $domain, $company, $firstName, $lastName, $fullName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailFinderApi->emailFinder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EmailFinderApi;

my $api_instance = WWW::SwaggerClient::EmailFinderApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apiKey = apiKey_example; # String | Don't change the value
my $domain = domain_example; # String | Domain name from which you want to find the email addresses. For example, "stripe.com".
my $company = company_example; # String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
my $firstName = firstName_example; # String | The person's first name. It doesn't need to be in lowercase.
my $lastName = lastName_example; # String | The person's last name. It doesn't need to be in lowercase.
my $fullName = fullName_example; # String | The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase.

eval { 
    my $result = $api_instance->emailFinder(apiecoKey => $apiecoKey, apiKey => $apiKey, domain => $domain, company => $company, firstName => $firstName, lastName => $lastName, fullName => $fullName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EmailFinderApi->emailFinder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EmailFinderApi()
apiecoKey = apiecoKey_example # String | 
apiKey = apiKey_example # String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
domain = domain_example # String | Domain name from which you want to find the email addresses. For example, "stripe.com".
company = company_example # String | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
firstName = firstName_example # String | The person's first name. It doesn't need to be in lowercase. (optional)
lastName = lastName_example # String | The person's last name. It doesn't need to be in lowercase. (optional)
fullName = fullName_example # String | The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase. (optional)

try: 
    api_response = api_instance.email_finder(apiecoKey, apiKey, domain, company, firstName=firstName, lastName=lastName, fullName=fullName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailFinderApi->emailFinder: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
api_key*
String
Don't change the value
Required
domain*
String
Domain name from which you want to find the email addresses. For example, "stripe.com".
Required
company*
String
The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
Required
first_name
String
The person's first name. It doesn't need to be in lowercase.
last_name
String
The person's last name. It doesn't need to be in lowercase.
full_name
String
The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase.

Responses

Status: 200 - Successful


EmailVerifier

emailVerifier

This API endpoint allows you to verify the deliverability of an email address. Hunter focuses on B2B. Therefore, webmails are not verified. We'll run every check but won't reach the remote SMTP server. This endpoint is rate-limited by domain name. You can check up to 200 email addresses for a domain name every 24 hours. You can check the number of requests remaining using the X-RateLimit-Remaining header. The request will run for 20 seconds. If it was not able to provide a response in time, we will return a 202 status code. You will then be able to poll the same endpoint to get the verification's result. Of course, all the requests in this case are counted only once.


/email-verifier

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/hunter/v2/email-verifier?api_key=&email="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EmailVerifierApi;

import java.io.File;
import java.util.*;

public class EmailVerifierApiExample {

    public static void main(String[] args) {
        
        EmailVerifierApi apiInstance = new EmailVerifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String email = email_example; // String | The email address you want to verify.
        try {
            inline_response_200_2 result = apiInstance.emailVerifier(apiecoKey, apiKey, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailVerifierApi#emailVerifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EmailVerifierApi;

public class EmailVerifierApiExample {

    public static void main(String[] args) {
        EmailVerifierApi apiInstance = new EmailVerifierApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        String email = email_example; // String | The email address you want to verify.
        try {
            inline_response_200_2 result = apiInstance.emailVerifier(apiecoKey, apiKey, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailVerifierApi#emailVerifier");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apiKey = apiKey_example; // Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
String *email = email_example; // The email address you want to verify.

EmailVerifierApi *apiInstance = [[EmailVerifierApi alloc] init];

[apiInstance emailVerifierWith:apiecoKey
    apiKey:apiKey
    email:email
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HuntersApiDocumentation = require('hunters_api_documentation');

var api = new HuntersApiDocumentation.EmailVerifierApi()

var apiecoKey = apiecoKey_example; // {String} 

var apiKey = apiKey_example; // {String} Don't change the value

var email = email_example; // {String} The email address you want to verify.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emailVerifier(apiecoKey, apiKey, email, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class emailVerifierExample
    {
        public void main()
        {
            
            var apiInstance = new EmailVerifierApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apiKey = apiKey_example;  // String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
            var email = email_example;  // String | The email address you want to verify.

            try
            {
                inline_response_200_2 result = apiInstance.emailVerifier(apiecoKey, apiKey, email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailVerifierApi.emailVerifier: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EmailVerifierApi();
$apiecoKey = apiecoKey_example; // String | 
$apiKey = apiKey_example; // String | Don't change the value
$email = email_example; // String | The email address you want to verify.

try {
    $result = $api_instance->emailVerifier($apiecoKey, $apiKey, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailVerifierApi->emailVerifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EmailVerifierApi;

my $api_instance = WWW::SwaggerClient::EmailVerifierApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apiKey = apiKey_example; # String | Don't change the value
my $email = email_example; # String | The email address you want to verify.

eval { 
    my $result = $api_instance->emailVerifier(apiecoKey => $apiecoKey, apiKey => $apiKey, email => $email);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EmailVerifierApi->emailVerifier: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EmailVerifierApi()
apiecoKey = apiecoKey_example # String | 
apiKey = apiKey_example # String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
email = email_example # String | The email address you want to verify.

try: 
    api_response = api_instance.email_verifier(apiecoKey, apiKey, email)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailVerifierApi->emailVerifier: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
api_key*
String
Don't change the value
Required
email*
String
The email address you want to verify.
Required

Responses

Status: 200 - Successful


ListAllYourLeads

allLeads

Returns all the leads already saved in your account. The leads are returned in sorted order, with the most recent leads appearing first. The leads can be filtered by attributes. Three kind of values can be given: *: select all the leads where the attribute has any value. ~: select all the leads where the attribute is empty. Any other string: select all the leads where the attribute contains the given value.


/leads

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/hunter/v2/leads?api_key=&limit=&lead_list_id=&first_name=&last_name=&email=&position=&company=&industry="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListAllYourLeadsApi;

import java.io.File;
import java.util.*;

public class ListAllYourLeadsApiExample {

    public static void main(String[] args) {
        
        ListAllYourLeadsApi apiInstance = new ListAllYourLeadsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        BigDecimal limit = 8.14; // BigDecimal | A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20
        String leadListId = leadListId_example; // String | Only returns the leads belonging to this list.
        String firstName = firstName_example; // String | The person's first name. It doesn't need to be in lowercase.
        String lastName = lastName_example; // String | The person's last name. It doesn't need to be in lowercase.
        String email = email_example; // String | Filters the leads by email.
        String position = position_example; // String | Filters the leads by position.
        String company = company_example; // String | Filters the leads by company.
        String industry = industry_example; // String | Filters the leads by industry.
        try {
            inline_response_200_1 result = apiInstance.allLeads(apiecoKey, apiKey, limit, leadListId, firstName, lastName, email, position, company, industry);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListAllYourLeadsApi#allLeads");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListAllYourLeadsApi;

public class ListAllYourLeadsApiExample {

    public static void main(String[] args) {
        ListAllYourLeadsApi apiInstance = new ListAllYourLeadsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        BigDecimal limit = 8.14; // BigDecimal | A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20
        String leadListId = leadListId_example; // String | Only returns the leads belonging to this list.
        String firstName = firstName_example; // String | The person's first name. It doesn't need to be in lowercase.
        String lastName = lastName_example; // String | The person's last name. It doesn't need to be in lowercase.
        String email = email_example; // String | Filters the leads by email.
        String position = position_example; // String | Filters the leads by position.
        String company = company_example; // String | Filters the leads by company.
        String industry = industry_example; // String | Filters the leads by industry.
        try {
            inline_response_200_1 result = apiInstance.allLeads(apiecoKey, apiKey, limit, leadListId, firstName, lastName, email, position, company, industry);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListAllYourLeadsApi#allLeads");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apiKey = apiKey_example; // Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
BigDecimal *limit = 8.14; // A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20 (optional)
String *leadListId = leadListId_example; // Only returns the leads belonging to this list. (optional)
String *firstName = firstName_example; // The person's first name. It doesn't need to be in lowercase. (optional)
String *lastName = lastName_example; // The person's last name. It doesn't need to be in lowercase. (optional)
String *email = email_example; // Filters the leads by email. (optional)
String *position = position_example; // Filters the leads by position. (optional)
String *company = company_example; // Filters the leads by company. (optional)
String *industry = industry_example; // Filters the leads by industry. (optional)

ListAllYourLeadsApi *apiInstance = [[ListAllYourLeadsApi alloc] init];

[apiInstance allLeadsWith:apiecoKey
    apiKey:apiKey
    limit:limit
    leadListId:leadListId
    firstName:firstName
    lastName:lastName
    email:email
    position:position
    company:company
    industry:industry
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HuntersApiDocumentation = require('hunters_api_documentation');

var api = new HuntersApiDocumentation.ListAllYourLeadsApi()

var apiecoKey = apiecoKey_example; // {String} 

var apiKey = apiKey_example; // {String} Don't change the value

var opts = { 
  'limit': 8.14, // {BigDecimal} A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20
  'leadListId': leadListId_example, // {String} Only returns the leads belonging to this list.
  'firstName': firstName_example, // {String} The person's first name. It doesn't need to be in lowercase.
  'lastName': lastName_example, // {String} The person's last name. It doesn't need to be in lowercase.
  'email': email_example, // {String} Filters the leads by email.
  'position': position_example, // {String} Filters the leads by position.
  'company': company_example, // {String} Filters the leads by company.
  'industry': industry_example // {String} Filters the leads by industry.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allLeads(apiecoKey, apiKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class allLeadsExample
    {
        public void main()
        {
            
            var apiInstance = new ListAllYourLeadsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apiKey = apiKey_example;  // String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
            var limit = 8.14;  // BigDecimal | A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20 (optional) 
            var leadListId = leadListId_example;  // String | Only returns the leads belonging to this list. (optional) 
            var firstName = firstName_example;  // String | The person's first name. It doesn't need to be in lowercase. (optional) 
            var lastName = lastName_example;  // String | The person's last name. It doesn't need to be in lowercase. (optional) 
            var email = email_example;  // String | Filters the leads by email. (optional) 
            var position = position_example;  // String | Filters the leads by position. (optional) 
            var company = company_example;  // String | Filters the leads by company. (optional) 
            var industry = industry_example;  // String | Filters the leads by industry. (optional) 

            try
            {
                inline_response_200_1 result = apiInstance.allLeads(apiecoKey, apiKey, limit, leadListId, firstName, lastName, email, position, company, industry);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListAllYourLeadsApi.allLeads: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ListAllYourLeadsApi();
$apiecoKey = apiecoKey_example; // String | 
$apiKey = apiKey_example; // String | Don't change the value
$limit = 8.14; // BigDecimal | A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20
$leadListId = leadListId_example; // String | Only returns the leads belonging to this list.
$firstName = firstName_example; // String | The person's first name. It doesn't need to be in lowercase.
$lastName = lastName_example; // String | The person's last name. It doesn't need to be in lowercase.
$email = email_example; // String | Filters the leads by email.
$position = position_example; // String | Filters the leads by position.
$company = company_example; // String | Filters the leads by company.
$industry = industry_example; // String | Filters the leads by industry.

try {
    $result = $api_instance->allLeads($apiecoKey, $apiKey, $limit, $leadListId, $firstName, $lastName, $email, $position, $company, $industry);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListAllYourLeadsApi->allLeads: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListAllYourLeadsApi;

my $api_instance = WWW::SwaggerClient::ListAllYourLeadsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apiKey = apiKey_example; # String | Don't change the value
my $limit = 8.14; # BigDecimal | A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20
my $leadListId = leadListId_example; # String | Only returns the leads belonging to this list.
my $firstName = firstName_example; # String | The person's first name. It doesn't need to be in lowercase.
my $lastName = lastName_example; # String | The person's last name. It doesn't need to be in lowercase.
my $email = email_example; # String | Filters the leads by email.
my $position = position_example; # String | Filters the leads by position.
my $company = company_example; # String | Filters the leads by company.
my $industry = industry_example; # String | Filters the leads by industry.

eval { 
    my $result = $api_instance->allLeads(apiecoKey => $apiecoKey, apiKey => $apiKey, limit => $limit, leadListId => $leadListId, firstName => $firstName, lastName => $lastName, email => $email, position => $position, company => $company, industry => $industry);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListAllYourLeadsApi->allLeads: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ListAllYourLeadsApi()
apiecoKey = apiecoKey_example # String | 
apiKey = apiKey_example # String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
limit = 8.14 # BigDecimal | A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20 (optional)
leadListId = leadListId_example # String | Only returns the leads belonging to this list. (optional)
firstName = firstName_example # String | The person's first name. It doesn't need to be in lowercase. (optional)
lastName = lastName_example # String | The person's last name. It doesn't need to be in lowercase. (optional)
email = email_example # String | Filters the leads by email. (optional)
position = position_example # String | Filters the leads by position. (optional)
company = company_example # String | Filters the leads by company. (optional)
industry = industry_example # String | Filters the leads by industry. (optional)

try: 
    api_response = api_instance.all_leads(apiecoKey, apiKey, limit=limit, leadListId=leadListId, firstName=firstName, lastName=lastName, email=email, position=position, company=company, industry=industry)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListAllYourLeadsApi->allLeads: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
api_key*
String
Don't change the value
Required
limit
BigDecimal
A limit on the number of leads to be returned. Limit can range between 1 and 100 leads. Default is 20
lead_list_id
String
Only returns the leads belonging to this list.
first_name
String
The person's first name. It doesn't need to be in lowercase.
last_name
String
The person's last name. It doesn't need to be in lowercase.
email
String
Filters the leads by email.
position
String
Filters the leads by position.
company
String
Filters the leads by company.
industry
String
Filters the leads by industry.

Responses

Status: 200 - Successful


ListAllYourLeadsLists

listLeads

Returns all the leads lists already saved in your account. The leads lists are returned in sorted order, with the most recent leads lists appearing first.


/leads_list

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/hunter/v2/leads_list?api_key=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListAllYourLeadsListsApi;

import java.io.File;
import java.util.*;

public class ListAllYourLeadsListsApiExample {

    public static void main(String[] args) {
        
        ListAllYourLeadsListsApi apiInstance = new ListAllYourLeadsListsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        BigDecimal offset = 8.14; // BigDecimal | The number of lists to skip. Use this parameter to fetch all the lists.
        BigDecimal limit = 8.14; // BigDecimal | A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20.
        try {
            inline_response_200_3 result = apiInstance.listLeads(apiecoKey, apiKey, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListAllYourLeadsListsApi#listLeads");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListAllYourLeadsListsApi;

public class ListAllYourLeadsListsApiExample {

    public static void main(String[] args) {
        ListAllYourLeadsListsApi apiInstance = new ListAllYourLeadsListsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apiKey = apiKey_example; // String | Don't change the value
        BigDecimal offset = 8.14; // BigDecimal | The number of lists to skip. Use this parameter to fetch all the lists.
        BigDecimal limit = 8.14; // BigDecimal | A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20.
        try {
            inline_response_200_3 result = apiInstance.listLeads(apiecoKey, apiKey, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListAllYourLeadsListsApi#listLeads");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apiKey = apiKey_example; // Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
BigDecimal *offset = 8.14; // The number of lists to skip. Use this parameter to fetch all the lists. (optional)
BigDecimal *limit = 8.14; // A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20. (optional)

ListAllYourLeadsListsApi *apiInstance = [[ListAllYourLeadsListsApi alloc] init];

[apiInstance listLeadsWith:apiecoKey
    apiKey:apiKey
    offset:offset
    limit:limit
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HuntersApiDocumentation = require('hunters_api_documentation');

var api = new HuntersApiDocumentation.ListAllYourLeadsListsApi()

var apiecoKey = apiecoKey_example; // {String} 

var apiKey = apiKey_example; // {String} Don't change the value

var opts = { 
  'offset': 8.14, // {BigDecimal} The number of lists to skip. Use this parameter to fetch all the lists.
  'limit': 8.14 // {BigDecimal} A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listLeads(apiecoKey, apiKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listLeadsExample
    {
        public void main()
        {
            
            var apiInstance = new ListAllYourLeadsListsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apiKey = apiKey_example;  // String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
            var offset = 8.14;  // BigDecimal | The number of lists to skip. Use this parameter to fetch all the lists. (optional) 
            var limit = 8.14;  // BigDecimal | A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20. (optional) 

            try
            {
                inline_response_200_3 result = apiInstance.listLeads(apiecoKey, apiKey, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListAllYourLeadsListsApi.listLeads: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ListAllYourLeadsListsApi();
$apiecoKey = apiecoKey_example; // String | 
$apiKey = apiKey_example; // String | Don't change the value
$offset = 8.14; // BigDecimal | The number of lists to skip. Use this parameter to fetch all the lists.
$limit = 8.14; // BigDecimal | A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20.

try {
    $result = $api_instance->listLeads($apiecoKey, $apiKey, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListAllYourLeadsListsApi->listLeads: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListAllYourLeadsListsApi;

my $api_instance = WWW::SwaggerClient::ListAllYourLeadsListsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apiKey = apiKey_example; # String | Don't change the value
my $offset = 8.14; # BigDecimal | The number of lists to skip. Use this parameter to fetch all the lists.
my $limit = 8.14; # BigDecimal | A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20.

eval { 
    my $result = $api_instance->listLeads(apiecoKey => $apiecoKey, apiKey => $apiKey, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListAllYourLeadsListsApi->listLeads: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ListAllYourLeadsListsApi()
apiecoKey = apiecoKey_example # String | 
apiKey = apiKey_example # String | Don't change the value (default to 7c3e3b113cb33e1d6d08c9e2f7205ae48e0f4bee)
offset = 8.14 # BigDecimal | The number of lists to skip. Use this parameter to fetch all the lists. (optional)
limit = 8.14 # BigDecimal | A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20. (optional)

try: 
    api_response = api_instance.list_leads(apiecoKey, apiKey, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListAllYourLeadsListsApi->listLeads: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
api_key*
String
Don't change the value
Required
offset
BigDecimal
The number of lists to skip. Use this parameter to fetch all the lists.
limit
BigDecimal
A limit on the number of lists to be returned. Limit can range between 1 and 100 lists. Default is 20.

Responses

Status: 200 - Successful