People Data Labs Rust Client

Table of Contents

🔧 Installation

cargo add peopledatalabs

🚀 Usage

let api_key = std::env::var("PDL_API_KEY").unwrap();let client =PDL::new(&api_key);

Person Data

Enrichment

letmut person_params =PersonParams::default();person_params.name =Some(vec!["josh finnie".to_string()]);person_params.location =Some(vec!["washington, dc".to_string()]);letmut enrich_params =EnrichPersonParams::default();enrich_params.person_params = person_params.clone();let results = client.person.enrich(enrich_params);

Bulk Enrichment

letmut person_params =PersonParams::default();person_params.name =Some(vec!["josh finnie".to_string()]);person_params.location =Some(vec!["washington, dc".to_string()]);let request =BulkEnrichSinglePersonParams{params: person_params.clone(),metadata:None,};let bulk_enrich_params =BulkEnrichPersonParams{requests:vec![request],};let results = client.person.bulk_enrich(bulk_enrich_params);

Search (Elasticsearch)

letmut search_base_params =SearchBaseParams::default();search_base_params.query =Some(serde_json::value::Value::String("{'bool':{'must': [{'term': {'job_title_role': 'health'}},]}}".to_string(),));letmut search_params =SearchParams::default();search_params.search_base_params = search_base_params;let search_results = client.person.search(search_params);

Search (SQL)

let query =r#"    SELECT * FROM person        WHERE location_country='mexico'        AND job_title_role='health'        AND phone_numbers IS NOT NULL;"#.to_string();letmut search_base_params =SeachBaseParams::default();search_base_params.sql = query;letmut seach_params =SearchParams::default();search_params.search_base_params = search_base_params;let search_results = client.person.searach(seach_params);

PDL_ID (Retrieve API)

let retrieve_person_params =RetrievePersonParams{base_params:None,person_id:"82MYIGZzMttzdyKiQBv4ZQ_0000".to_string(),};let retrieve_results = client.person.retrieve(retrieve_person_params);

Bulk Retrieve API

let retrieve_request =BulkRetrieveSinglePersonParams{id:"82MYIGZzMttzdyKiQBv4ZQ_0000".to_string(),metadata:None,};letmut bulk_retrieve_params =BulkRetrievePersonParams::default();bulk_retrieve_params.requests =vec![retrieve_request];let bulk_retrieve_results = client.person.bulk_retrieve(bulk_retrieve_params);

Fuzzy Enrichment (Identify API)

letmut person_params =PersonParams::default();person_params.name =Some(vec!["josh finnie".to_string()]);person_params.location =Some(vec!["washington, dc".to_string()]);letmut identify_params =IdentifyPersonParams::default();identify_params.person_params = person_params.clone();let identify_results = client.person.identify(identify_params);

Company Data

Enrichment

letmut company_params =CompanyParams::default();company_params.name =Some("google".to_string());let enrich_params =EnrichCompanyParams{base_params:None,    company_params,additional_params:None,};let enrich_request = client.company.enrich(enrich_params);

Search (Elasticsearch)

letmut search_base_params =SearchBaseParams::default();search_base_params.query =Some(serde_json::value::Value::String(r#"{'query': {'bool': {'must': {            {"term": {"tags": "bigdata"}},            {"term": {"industry": "financial services"}},            {"term": {"location.country": "united states"}},        },},},    }"#.to_string(),));letmut search_params =SearchParams::default();search_params.search_base_params = search_base_params;let search_results = client.company.search(search_params);

Search (SQL)

letmut search_base_params =SearchBaseParams::default();search_base_params.sql =Some("SELECT * FROM company WHERE website='google.com';".to_string());let search_params =SearchParams{base_params:None,    search_base_params,additional_params:None,};let search_results = client.company.search(search_params);

Supporting APIs

Get Autocomplete Suggestions

let autocomplete_base_params =AutocompleteBaseParams{field:"text".to_string(),text:Some("full".to_string())};let autocomplete_params =AutocompleteParams{base_params:None,    autocomplete_base_params,};let request = client.autocomplete.autocomplete(autocomplete_params);

Clean Raw Company Strings

letmut clean_params =CleanCompanyParams::default();clean_params.name =Some("google".to_string());let clean_results = client.company.clean(clean_params);

Clean Raw Location Strings

let base_params =BaseParams::default();let location_params =LocationParams{location:Some("New York, NY".to_string()),};let params =CleanLocationParams{base_params:None,    location_params,additional_params:None,};let results = client.location.clean(params);

Clean Raw School Strings

letmut school_params =SchoolParams::default();school_params.name =Some("UConn".to_string());let params =CleanSchoolParams{base_params:None,    school_params,additional_params:None,};let results = client.school.clean(params);

Enrich Job Title

let job_title_base_params =JobTitleBaseParams{job_title:Some("software engineer".to_string()),};let params =JobTitleParams{base_params:None,    job_title_base_params,};let results = client.job_title.get(params);

Enrich IP

letmut ip_base_params =IPBaseParams::default();ip_base_params.ip =Some("72.212.42.228".to_string());let params =IPParams{base_params:None,    ip_base_params,};let results = client.ip.get(params);

🏝 Sandbox Usage

// To enable sandbox usage, pass in the following options to the PDLClient before buildinglet api_key = std::env::var("PDL_API_KEY").unwrap();letmut client_options =PDLCLientOptions::default();client_options.sandbox =true;let client =PDLClient::new(&api_key).options(client_options).build();

🌐 Endpoints

📘 Documentation