docs/PersonalApi.md
In namsor/namsor-r-sdk2: R Package Client for NamSor API v2
PersonalApi
All URIs are relative to https://v2.namsor.com/NamSorAPIv2
Method | HTTP request | Description
------------- | ------------- | -------------
Country | GET /api2/json/country/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
CountryBatch | POST /api2/json/countryBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
Diaspora | GET /api2/json/diaspora/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
DiasporaBatch | POST /api2/json/diasporaBatch | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Gender | GET /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name.
GenderBatch | POST /api2/json/genderBatch | Infer the likely gender of up to 100 names, detecting automatically the cultural context.
GenderFull | GET /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith
GenderFullBatch | POST /api2/json/genderFullBatch | Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
GenderFullGeo | GET /api2/json/genderFullGeo/{fullName}/{countryIso2} | Infer the likely gender of a full name, given a local context (ISO2 country code).
GenderFullGeoBatch | POST /api2/json/genderFullGeoBatch | Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
GenderGeo | GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} | Infer the likely gender of a name, given a local context (ISO2 country code).
GenderGeoBatch | POST /api2/json/genderGeoBatch | Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
Origin | GET /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
OriginBatch | POST /api2/json/originBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
ParseName | GET /api2/json/parseName/{nameFull} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
ParseNameBatch | POST /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
ParseNameGeo | GET /api2/json/parseName/{nameFull}/{countryIso2} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
ParseNameGeoBatch | POST /api2/json/parseNameGeoBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
ParsedGenderBatch | POST /api2/json/parsedGenderBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
ParsedGenderGeoBatch | POST /api2/json/parsedGenderGeoBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
UsRaceEthnicity | GET /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
UsRaceEthnicityBatch | POST /api2/json/usRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy.
UsRaceEthnicityZIP5 | GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
UsZipRaceEthnicityBatch | POST /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Country
PersonalNameGeoOut Country(personal.name.full)
[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.personal.name.full <- 'personal.name.full_example' # character |
#[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Country(var.personal.name.full)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
personal.name.full | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A origined name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
CountryBatch
BatchPersonalNameGeoOut CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new(list(PersonalNameIn$new("id_example", "name_example"))) # BatchPersonalNameIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
Diaspora
FirstLastNameDiasporaedOut Diaspora(country.iso2, first.name, last.name)
[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.country.iso2 <- 'country.iso2_example' # character |
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Diaspora(var.country.iso2, var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
country.iso2 | character| |
first.name | character| |
last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A diaspora / ethnicity for given name and geography. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
DiasporaBatch
BatchFirstLastNameDiasporaedOut DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new(list(FirstLastNameGeoIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example"))) # BatchFirstLastNameGeoIn | A list of personal names
#[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameDiasporaedOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of diaspora / ethnicity given a name and residency. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
Gender
FirstLastNameGenderedOut Gender(first.name, last.name)
Infer the likely gender of a name.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#Infer the likely gender of a name.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Gender(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A genderized name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
GenderBatch
BatchFirstLastNameGenderedOut GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
Infer the likely gender of up to 100 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new(list(FirstLastNameIn$new("id_example", "firstName_example", "lastName_example"))) # BatchFirstLastNameIn | A list of personal names
#Infer the likely gender of up to 100 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
GenderFull
PersonalNameGenderedOut GenderFull(full.name)
Infer the likely gender of a full name, ex. John H. Smith
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
#Infer the likely gender of a full name, ex. John H. Smith
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFull(var.full.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
full.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A genderized name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
GenderFullBatch
BatchPersonalNameGenderedOut GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new(list(PersonalNameIn$new("id_example", "name_example"))) # BatchPersonalNameIn | A list of personal names
#Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
GenderFullGeo
PersonalNameGenderedOut GenderFullGeo(full.name, country.iso2)
Infer the likely gender of a full name, given a local context (ISO2 country code).
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a full name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeo(var.full.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
full.name | character| |
country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A genderized name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
GenderFullGeoBatch
BatchPersonalNameGenderedOut GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
Example
library(namsor)
var.batch.personal.name.geo.in <- BatchPersonalNameGeoIn$new(list(PersonalNameGeoIn$new("id_example", "name_example", "countryIso2_example"))) # BatchPersonalNameGeoIn | A list of personal names, with a country ISO2 code
#Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.geo.in | BatchPersonalNameGeoIn| A list of personal names, with a country ISO2 code | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
GenderGeo
FirstLastNameGenderedOut GenderGeo(first.name, last.name, country.iso2)
Infer the likely gender of a name, given a local context (ISO2 country code).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeo(var.first.name, var.last.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A genderized name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
GenderGeoBatch
BatchFirstLastNameGenderedOut GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new(list(FirstLastNameGeoIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example"))) # BatchFirstLastNameGeoIn | A list of names, with country code.
#Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of names, with country code. | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
Origin
FirstLastNameOriginedOut Origin(first.name, last.name)
[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Origin(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A origined name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
OriginBatch
BatchFirstLastNameOriginedOut OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new(list(FirstLastNameIn$new("id_example", "firstName_example", "lastName_example"))) # BatchFirstLastNameIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
ParseName
PersonalNameParsedOut ParseName(name.full)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
Example
library(namsor)
var.name.full <- 'name.full_example' # character |
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseName(var.name.full)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
name.full | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A origined name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
ParseNameBatch
BatchPersonalNameParsedOut ParseNameBatch(batch.personal.name.in=var.batch.personal.name.in)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new(list(PersonalNameIn$new("id_example", "name_example"))) # BatchPersonalNameIn | A list of personal names
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseNameBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of parsed names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
ParseNameGeo
PersonalNameParsedOut ParseNameGeo(name.full, country.iso2)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
Example
library(namsor)
var.name.full <- 'name.full_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseNameGeo(var.name.full, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
name.full | character| |
country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A origined name. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
ParseNameGeoBatch
BatchPersonalNameParsedOut ParseNameGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
Example
library(namsor)
var.batch.personal.name.geo.in <- BatchPersonalNameGeoIn$new(list(PersonalNameGeoIn$new("id_example", "name_example", "countryIso2_example"))) # BatchPersonalNameGeoIn | A list of personal names
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseNameGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.geo.in | BatchPersonalNameGeoIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of parsed names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
ParsedGenderBatch
BatchFirstLastNameGenderedOut ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.in <- BatchParsedFullNameIn$new(list(ParsedFullNameIn$new("id_example", "firstName_example", "lastName_example", "prefixOrTitle_example", "suffix_example", "middleName_example"))) # BatchParsedFullNameIn | A list of personal names
#Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.parsed.full.name.in | BatchParsedFullNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
ParsedGenderGeoBatch
BatchFirstLastNameGenderedOut ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.geo.in <- BatchParsedFullNameGeoIn$new(list(ParsedFullNameGeoIn$new("id_example", "firstName_example", "lastName_example", "prefixOrTitle_example", "suffix_example", "middleName_example", "countryIso2_example"))) # BatchParsedFullNameGeoIn | A list of personal names
#Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.parsed.full.name.geo.in | BatchParsedFullNameGeoIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of genderized names. | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
UsRaceEthnicity
FirstLastNameUSRaceEthnicityOut UsRaceEthnicity(first.name, last.name)
[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicity(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
UsRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy.
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new(list(FirstLastNameGeoIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example"))) # BatchFirstLastNameGeoIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
UsRaceEthnicityZIP5
FirstLastNameUSRaceEthnicityOut UsRaceEthnicityZIP5(first.name, last.name, zip5.code)
[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.zip5.code <- 'zip5.code_example' # character |
#[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityZIP5(var.first.name, var.last.name, var.zip5.code)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
zip5.code | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
UsZipRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Example
library(namsor)
var.batch.first.last.name.geo.zipped.in <- BatchFirstLastNameGeoZippedIn$new(list(FirstLastNameGeoZippedIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example", "zipCode_example"))) # BatchFirstLastNameGeoZippedIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.zipped.in | BatchFirstLastNameGeoZippedIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - |
| 401 | Missing or incorrect API Key | - |
| 403 | API Limit Reached or API Key Disabled | - |
namsor/namsor-r-sdk2 documentation built on March 15, 2021, 7:12 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
PersonalApi
All URIs are relative to https://v2.namsor.com/NamSorAPIv2
Method | HTTP request | Description ------------- | ------------- | ------------- Country | GET /api2/json/country/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. CountryBatch | POST /api2/json/countryBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. Diaspora | GET /api2/json/diaspora/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) DiasporaBatch | POST /api2/json/diasporaBatch | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) Gender | GET /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name. GenderBatch | POST /api2/json/genderBatch | Infer the likely gender of up to 100 names, detecting automatically the cultural context. GenderFull | GET /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith GenderFullBatch | POST /api2/json/genderFullBatch | Infer the likely gender of up to 100 full names, detecting automatically the cultural context. GenderFullGeo | GET /api2/json/genderFullGeo/{fullName}/{countryIso2} | Infer the likely gender of a full name, given a local context (ISO2 country code). GenderFullGeoBatch | POST /api2/json/genderFullGeoBatch | Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code). GenderGeo | GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} | Infer the likely gender of a name, given a local context (ISO2 country code). GenderGeoBatch | POST /api2/json/genderGeoBatch | Infer the likely gender of up to 100 names, each given a local context (ISO2 country code). Origin | GET /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. OriginBatch | POST /api2/json/originBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. ParseName | GET /api2/json/parseName/{nameFull} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. ParseNameBatch | POST /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. ParseNameGeo | GET /api2/json/parseName/{nameFull}/{countryIso2} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context. ParseNameGeoBatch | POST /api2/json/parseNameGeoBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision. ParsedGenderBatch | POST /api2/json/parsedGenderBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. ParsedGenderGeoBatch | POST /api2/json/parsedGenderGeoBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. UsRaceEthnicity | GET /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). UsRaceEthnicityBatch | POST /api2/json/usRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. UsRaceEthnicityZIP5 | GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). UsZipRaceEthnicityBatch | POST /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Country
PersonalNameGeoOut Country(personal.name.full)
[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.personal.name.full <- 'personal.name.full_example' # character |
#[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Country(var.personal.name.full)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- personal.name.full | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A origined name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
CountryBatch
BatchPersonalNameGeoOut CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new(list(PersonalNameIn$new("id_example", "name_example"))) # BatchPersonalNameIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
Diaspora
FirstLastNameDiasporaedOut Diaspora(country.iso2, first.name, last.name)
[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.country.iso2 <- 'country.iso2_example' # character |
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Diaspora(var.country.iso2, var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- country.iso2 | character| | first.name | character| | last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A diaspora / ethnicity for given name and geography. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
DiasporaBatch
BatchFirstLastNameDiasporaedOut DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new(list(FirstLastNameGeoIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example"))) # BatchFirstLastNameGeoIn | A list of personal names
#[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameDiasporaedOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of diaspora / ethnicity given a name and residency. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
Gender
FirstLastNameGenderedOut Gender(first.name, last.name)
Infer the likely gender of a name.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#Infer the likely gender of a name.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Gender(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A genderized name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
GenderBatch
BatchFirstLastNameGenderedOut GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
Infer the likely gender of up to 100 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new(list(FirstLastNameIn$new("id_example", "firstName_example", "lastName_example"))) # BatchFirstLastNameIn | A list of personal names
#Infer the likely gender of up to 100 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
GenderFull
PersonalNameGenderedOut GenderFull(full.name)
Infer the likely gender of a full name, ex. John H. Smith
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
#Infer the likely gender of a full name, ex. John H. Smith
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFull(var.full.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- full.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A genderized name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
GenderFullBatch
BatchPersonalNameGenderedOut GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new(list(PersonalNameIn$new("id_example", "name_example"))) # BatchPersonalNameIn | A list of personal names
#Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
GenderFullGeo
PersonalNameGenderedOut GenderFullGeo(full.name, country.iso2)
Infer the likely gender of a full name, given a local context (ISO2 country code).
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a full name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeo(var.full.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- full.name | character| | country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A genderized name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
GenderFullGeoBatch
BatchPersonalNameGenderedOut GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
Example
library(namsor)
var.batch.personal.name.geo.in <- BatchPersonalNameGeoIn$new(list(PersonalNameGeoIn$new("id_example", "name_example", "countryIso2_example"))) # BatchPersonalNameGeoIn | A list of personal names, with a country ISO2 code
#Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.geo.in | BatchPersonalNameGeoIn| A list of personal names, with a country ISO2 code | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
GenderGeo
FirstLastNameGenderedOut GenderGeo(first.name, last.name, country.iso2)
Infer the likely gender of a name, given a local context (ISO2 country code).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeo(var.first.name, var.last.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| | country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A genderized name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
GenderGeoBatch
BatchFirstLastNameGenderedOut GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new(list(FirstLastNameGeoIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example"))) # BatchFirstLastNameGeoIn | A list of names, with country code.
#Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of names, with country code. | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
Origin
FirstLastNameOriginedOut Origin(first.name, last.name)
[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Origin(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A origined name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
OriginBatch
BatchFirstLastNameOriginedOut OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new(list(FirstLastNameIn$new("id_example", "firstName_example", "lastName_example"))) # BatchFirstLastNameIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
ParseName
PersonalNameParsedOut ParseName(name.full)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
Example
library(namsor)
var.name.full <- 'name.full_example' # character |
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseName(var.name.full)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- name.full | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A origined name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
ParseNameBatch
BatchPersonalNameParsedOut ParseNameBatch(batch.personal.name.in=var.batch.personal.name.in)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new(list(PersonalNameIn$new("id_example", "name_example"))) # BatchPersonalNameIn | A list of personal names
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseNameBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of parsed names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
ParseNameGeo
PersonalNameParsedOut ParseNameGeo(name.full, country.iso2)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
Example
library(namsor)
var.name.full <- 'name.full_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseNameGeo(var.name.full, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- name.full | character| | country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A origined name. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
ParseNameGeoBatch
BatchPersonalNameParsedOut ParseNameGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
Example
library(namsor)
var.batch.personal.name.geo.in <- BatchPersonalNameGeoIn$new(list(PersonalNameGeoIn$new("id_example", "name_example", "countryIso2_example"))) # BatchPersonalNameGeoIn | A list of personal names
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParseNameGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.geo.in | BatchPersonalNameGeoIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of parsed names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
ParsedGenderBatch
BatchFirstLastNameGenderedOut ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.in <- BatchParsedFullNameIn$new(list(ParsedFullNameIn$new("id_example", "firstName_example", "lastName_example", "prefixOrTitle_example", "suffix_example", "middleName_example"))) # BatchParsedFullNameIn | A list of personal names
#Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.parsed.full.name.in | BatchParsedFullNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
ParsedGenderGeoBatch
BatchFirstLastNameGenderedOut ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.geo.in <- BatchParsedFullNameGeoIn$new(list(ParsedFullNameGeoIn$new("id_example", "firstName_example", "lastName_example", "prefixOrTitle_example", "suffix_example", "middleName_example", "countryIso2_example"))) # BatchParsedFullNameGeoIn | A list of personal names
#Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.parsed.full.name.geo.in | BatchParsedFullNameGeoIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of genderized names. | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
UsRaceEthnicity
FirstLastNameUSRaceEthnicityOut UsRaceEthnicity(first.name, last.name)
[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicity(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
UsRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy.
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new(list(FirstLastNameGeoIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example"))) # BatchFirstLastNameGeoIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
UsRaceEthnicityZIP5
FirstLastNameUSRaceEthnicityOut UsRaceEthnicityZIP5(first.name, last.name, zip5.code)
[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.zip5.code <- 'zip5.code_example' # character |
#[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityZIP5(var.first.name, var.last.name, var.zip5.code)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| | zip5.code | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
UsZipRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Example
library(namsor)
var.batch.first.last.name.geo.zipped.in <- BatchFirstLastNameGeoZippedIn$new(list(FirstLastNameGeoZippedIn$new("id_example", "firstName_example", "lastName_example", "countryIso2_example", "zipCode_example"))) # BatchFirstLastNameGeoZippedIn | A list of personal names
#[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.zipped.in | BatchFirstLastNameGeoZippedIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). | - | | 401 | Missing or incorrect API Key | - | | 403 | API Limit Reached or API Key Disabled | - |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.