All URIs are relative to https://v2.namsor.com/NamSorAPIv2
Method | HTTP request | Description |
---|---|---|
country | GET /api2/json/country/{personalNameFull} | [USES 10 UNITS] 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. |
country_batch | POST /api2/json/countryBatch | [USES 10 UNITS] Infer the likely country of residence of up to 1000 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] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) |
diaspora_batch | POST /api2/json/diasporaBatch | [USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 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. |
gender_batch | POST /api2/json/genderBatch | Infer the likely gender of up to 1000 names, detecting automatically the cultural context. |
gender_full | GET /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith |
gender_full_batch | POST /api2/json/genderFullBatch | Infer the likely gender of up to 1000 full names, detecting automatically the cultural context. |
gender_full_geo | GET /api2/json/genderFullGeo/{fullName}/{countryIso2} | Infer the likely gender of a full name, given a local context (ISO2 country code). |
gender_full_geo_batch | POST /api2/json/genderFullGeoBatch | Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code). |
gender_geo | GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} | Infer the likely gender of a name, given a local context (ISO2 country code). |
gender_geo_batch | POST /api2/json/genderGeoBatch | Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code). |
origin | GET /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS] 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. |
origin_batch | POST /api2/json/originBatch | [USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context. |
parse_name | GET /api2/json/parseName/{nameFull} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. |
parse_name_batch | POST /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. |
parse_name_geo | 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. |
parse_name_geo_batch | 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. |
parsed_gender_batch | POST /api2/json/parsedGenderBatch | Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context. |
parsed_gender_geo_batch | POST /api2/json/parsedGenderGeoBatch | Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context. |
us_race_ethnicity | GET /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS] 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). |
us_race_ethnicity_batch | POST /api2/json/usRaceEthnicityBatch | [USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy. |
us_race_ethnicity_zip5 | GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS] 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). |
us_zip_race_ethnicity_batch | POST /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. |
PersonalNameGeoOut country(personal_name_full)
[USES 10 UNITS] 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.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
personal_name_full = 'personal_name_full_example' # String |
begin
#[USES 10 UNITS] 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.
result = api_instance.country(personal_name_full)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->country: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
personal_name_full | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameGeoOut country_batch(opts)
[USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_personal_name_in: NamSorClient::BatchPersonalNameIn.new # BatchPersonalNameIn | A list of personal names
}
begin
#[USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
result = api_instance.country_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->country_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_personal_name_in | BatchPersonalNameIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
FirstLastNameDiasporaedOut diaspora(country_iso2, first_name, last_name)
[USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
country_iso2 = 'country_iso2_example' # String |
first_name = 'first_name_example' # String |
last_name = 'last_name_example' # String |
begin
#[USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
result = api_instance.diaspora(country_iso2, first_name, last_name)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->diaspora: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
country_iso2 | String | ||
first_name | String | ||
last_name | String |
- Content-Type: Not defined
- Accept: application/json
BatchFirstLastNameDiasporaedOut diaspora_batch(opts)
[USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_first_last_name_geo_in: NamSorClient::BatchFirstLastNameGeoIn.new # BatchFirstLastNameGeoIn | A list of personal names
}
begin
#[USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
result = api_instance.diaspora_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->diaspora_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_first_last_name_geo_in | BatchFirstLastNameGeoIn | A list of personal names | [optional] |
BatchFirstLastNameDiasporaedOut
- Content-Type: application/json
- Accept: application/json
FirstLastNameGenderedOut gender(first_name, last_name)
Infer the likely gender of a name.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
first_name = 'first_name_example' # String |
last_name = 'last_name_example' # String |
begin
#Infer the likely gender of a name.
result = api_instance.gender(first_name, last_name)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
first_name | String | ||
last_name | String |
- Content-Type: Not defined
- Accept: application/json
BatchFirstLastNameGenderedOut gender_batch(opts)
Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_first_last_name_in: NamSorClient::BatchFirstLastNameIn.new # BatchFirstLastNameIn | A list of personal names
}
begin
#Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
result = api_instance.gender_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_first_last_name_in | BatchFirstLastNameIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
FirstLastNameGenderedOut gender_full(full_name)
Infer the likely gender of a full name, ex. John H. Smith
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
full_name = 'full_name_example' # String |
begin
#Infer the likely gender of a full name, ex. John H. Smith
result = api_instance.gender_full(full_name)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender_full: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
full_name | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameGenderedOut gender_full_batch(opts)
Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_personal_name_in: NamSorClient::BatchPersonalNameIn.new # BatchPersonalNameIn | A list of personal names
}
begin
#Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
result = api_instance.gender_full_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender_full_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_personal_name_in | BatchPersonalNameIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
FirstLastNameGenderedOut gender_full_geo(full_name, country_iso2)
Infer the likely gender of a full name, given a local context (ISO2 country code).
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
full_name = 'full_name_example' # String |
country_iso2 = 'country_iso2_example' # String |
begin
#Infer the likely gender of a full name, given a local context (ISO2 country code).
result = api_instance.gender_full_geo(full_name, country_iso2)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender_full_geo: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
full_name | String | ||
country_iso2 | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameGenderedOut gender_full_geo_batch(opts)
Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_personal_name_geo_in: NamSorClient::BatchPersonalNameGeoIn.new # BatchPersonalNameGeoIn | A list of personal names, with a country ISO2 code
}
begin
#Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
result = api_instance.gender_full_geo_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender_full_geo_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_personal_name_geo_in | BatchPersonalNameGeoIn | A list of personal names, with a country ISO2 code | [optional] |
- Content-Type: application/json
- Accept: application/json
FirstLastNameGenderedOut gender_geo(first_name, last_name, country_iso2)
Infer the likely gender of a name, given a local context (ISO2 country code).
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
first_name = 'first_name_example' # String |
last_name = 'last_name_example' # String |
country_iso2 = 'country_iso2_example' # String |
begin
#Infer the likely gender of a name, given a local context (ISO2 country code).
result = api_instance.gender_geo(first_name, last_name, country_iso2)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender_geo: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
first_name | String | ||
last_name | String | ||
country_iso2 | String |
- Content-Type: Not defined
- Accept: application/json
BatchFirstLastNameGenderedOut gender_geo_batch(opts)
Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_first_last_name_geo_in: NamSorClient::BatchFirstLastNameGeoIn.new # BatchFirstLastNameGeoIn | A list of names, with country code.
}
begin
#Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
result = api_instance.gender_geo_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->gender_geo_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_first_last_name_geo_in | BatchFirstLastNameGeoIn | A list of names, with country code. | [optional] |
- Content-Type: application/json
- Accept: application/json
FirstLastNameOriginedOut origin(first_name, last_name)
[USES 10 UNITS] 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.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
first_name = 'first_name_example' # String |
last_name = 'last_name_example' # String |
begin
#[USES 10 UNITS] 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.
result = api_instance.origin(first_name, last_name)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->origin: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
first_name | String | ||
last_name | String |
- Content-Type: Not defined
- Accept: application/json
BatchFirstLastNameOriginedOut origin_batch(opts)
[USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_first_last_name_in: NamSorClient::BatchFirstLastNameIn.new # BatchFirstLastNameIn | A list of personal names
}
begin
#[USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
result = api_instance.origin_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->origin_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_first_last_name_in | BatchFirstLastNameIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
PersonalNameParsedOut parse_name(name_full)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
name_full = 'name_full_example' # String |
begin
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
result = api_instance.parse_name(name_full)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->parse_name: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
name_full | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameParsedOut parse_name_batch(opts)
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_personal_name_in: NamSorClient::BatchPersonalNameIn.new # BatchPersonalNameIn | A list of personal names
}
begin
#Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
result = api_instance.parse_name_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->parse_name_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_personal_name_in | BatchPersonalNameIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
PersonalNameParsedOut parse_name_geo(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.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
name_full = 'name_full_example' # String |
country_iso2 = 'country_iso2_example' # String |
begin
#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.
result = api_instance.parse_name_geo(name_full, country_iso2)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->parse_name_geo: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
name_full | String | ||
country_iso2 | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameParsedOut parse_name_geo_batch(opts)
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.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_personal_name_geo_in: NamSorClient::BatchPersonalNameGeoIn.new # BatchPersonalNameGeoIn | A list of personal names
}
begin
#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.
result = api_instance.parse_name_geo_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->parse_name_geo_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_personal_name_geo_in | BatchPersonalNameGeoIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
BatchFirstLastNameGenderedOut parsed_gender_batch(opts)
Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_parsed_full_name_in: NamSorClient::BatchParsedFullNameIn.new # BatchParsedFullNameIn | A list of personal names
}
begin
#Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
result = api_instance.parsed_gender_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->parsed_gender_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_parsed_full_name_in | BatchParsedFullNameIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
BatchFirstLastNameGenderedOut parsed_gender_geo_batch(opts)
Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_parsed_full_name_geo_in: NamSorClient::BatchParsedFullNameGeoIn.new # BatchParsedFullNameGeoIn | A list of personal names
}
begin
#Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
result = api_instance.parsed_gender_geo_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->parsed_gender_geo_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_parsed_full_name_geo_in | BatchParsedFullNameGeoIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
FirstLastNameUSRaceEthnicityOut us_race_ethnicity(first_name, last_name)
[USES 10 UNITS] 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).
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
first_name = 'first_name_example' # String |
last_name = 'last_name_example' # String |
begin
#[USES 10 UNITS] 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).
result = api_instance.us_race_ethnicity(first_name, last_name)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->us_race_ethnicity: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
first_name | String | ||
last_name | String |
FirstLastNameUSRaceEthnicityOut
- Content-Type: Not defined
- Accept: application/json
BatchFirstLastNameUSRaceEthnicityOut us_race_ethnicity_batch(opts)
[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_first_last_name_geo_in: NamSorClient::BatchFirstLastNameGeoIn.new # BatchFirstLastNameGeoIn | A list of personal names
}
begin
#[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
result = api_instance.us_race_ethnicity_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->us_race_ethnicity_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_first_last_name_geo_in | BatchFirstLastNameGeoIn | A list of personal names | [optional] |
BatchFirstLastNameUSRaceEthnicityOut
- Content-Type: application/json
- Accept: application/json
FirstLastNameUSRaceEthnicityOut us_race_ethnicity_zip5(first_name, last_name, zip5_code)
[USES 10 UNITS] 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).
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
first_name = 'first_name_example' # String |
last_name = 'last_name_example' # String |
zip5_code = 'zip5_code_example' # String |
begin
#[USES 10 UNITS] 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).
result = api_instance.us_race_ethnicity_zip5(first_name, last_name, zip5_code)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->us_race_ethnicity_zip5: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
first_name | String | ||
last_name | String | ||
zip5_code | String |
FirstLastNameUSRaceEthnicityOut
- Content-Type: Not defined
- Accept: application/json
BatchFirstLastNameUSRaceEthnicityOut us_zip_race_ethnicity_batch(opts)
[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
# load the gem
require 'namsor_client'
# setup authorization
NamSorClient.configure do |config|
# Configure API key authorization: api_key
config.api_key['X-API-KEY'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-KEY'] = 'Bearer'
end
api_instance = NamSorClient::PersonalApi.new
opts = {
batch_first_last_name_geo_zipped_in: NamSorClient::BatchFirstLastNameGeoZippedIn.new # BatchFirstLastNameGeoZippedIn | A list of personal names
}
begin
#[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
result = api_instance.us_zip_race_ethnicity_batch(opts)
p result
rescue NamSorClient::ApiError => e
puts "Exception when calling PersonalApi->us_zip_race_ethnicity_batch: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
batch_first_last_name_geo_zipped_in | BatchFirstLastNameGeoZippedIn | A list of personal names | [optional] |
BatchFirstLastNameUSRaceEthnicityOut
- Content-Type: application/json
- Accept: application/json