Skip to content
NamSor API v2 R SDK - classify personal names accurately by gender, country of origin, or ethnicity.
Branch: master
Clone or download
Latest commit acb6bf5 Mar 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.openapi-generator Minor update Feb 21, 2019
R Minor update Mar 25, 2019
docs Minor update Mar 25, 2019
tests
.Rbuildignore Minor update Feb 21, 2019
.gitignore Minor update Feb 21, 2019
.openapi-generator-ignore
.travis.yml Minor update Feb 21, 2019
DESCRIPTION Minor update Mar 25, 2019
NAMESPACE
README.md
git_push.sh Minor update Mar 2, 2019

README.md

R API client for namsor

NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 1000 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it!

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

  • API version: 2.0.2-beta
  • Package version: 0.1.2
  • Build package: org.openapitools.codegen.languages.RClientCodegen For more information, please visit http://www.namsor.com/

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("caTools")

Build the package

git clone https://github.com/namsor/namsor-r-sdk2
cd namsor-r-sdk2
R CMD build .
R CMD check namsor_0.1.2.tar.gz
R CMD INSTALL namsor_0.1.2.tar.gz

Install the package

install.packages("namsor")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("namsor/namsor-r-sdk2")

Usage

library(namsor)

Documentation for API Endpoints

All URIs are relative to https://v2.namsor.com/NamSorAPIv2

Class Method HTTP request Description
AdminApi ApiUsage GET /api2/json/apiUsage Print current API usage.
AdminApi ApiUsageHistory GET /api2/json/apiUsageHistory Print historical API usage.
AdminApi ApiUsageHistoryAggregate GET /api2/json/apiUsageHistoryAggregate Print historical API usage (in an aggregated view, by service, by day/hour/min).
AdminApi AvailablePlans GET /api2/json/availablePlans List all available plans in the default currency (usd).
AdminApi AvailablePlans1 GET /api2/json/availablePlans/{token} List all available plans in the user's preferred currency.
AdminApi AvailableServices GET /api2/json/apiServices List of API services and usage cost in Units (default is 1=ONE Unit).
AdminApi BillingCurrencies GET /api2/json/billingCurrencies List possible currency options for billing (USD, EUR, GBP, ...)
AdminApi BillingHistory GET /api2/json/billingHistory/{token} Read the history billing information (invoices paid via Stripe or manually).
AdminApi BillingInfo GET /api2/json/billingInfo/{token} Read the billing information (company name, address, phone, vat ID)
AdminApi Charge POST /api2/json/charge Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email.
AdminApi CorporateKey GET /api2/json/corporateKey/{apiKey}/{corporate} Setting an API Key to a corporate status.
AdminApi DebugLevel GET /api2/json/debugLevel/{logger}/{level} Update debug level for a classifier
AdminApi Flush GET /api2/json/flush Flush counters.
AdminApi InvalidateCache GET /api2/json/invalidateCache Invalidate system caches.
AdminApi Learnable GET /api2/json/learnable/{source}/{learnable} Activate/deactivate learning from a source.
AdminApi NamsorCounter GET /api2/json/namsorCounter Get the overall API counter
AdminApi PaymentInfo GET /api2/json/paymentInfo/{token} Get the Stripe payment information associated with the current google auth session token.
AdminApi ProcureKey GET /api2/json/procureKey/{token} Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret.
AdminApi RedeployUI GET /api2/json/redeployUI Redeploy UI from current dev branch.
AdminApi RedeployUI1 GET /api2/json/redeployUI/{live} Redeploy UI from current dev branch.
AdminApi RemoveUserAccount GET /api2/json/removeUserAccount/{token} Subscribe to a give API plan, using the user's preferred or default currency.
AdminApi Shutdown GET /api2/json/shutdown Stop learning and shutdown system.
AdminApi SoftwareVersion GET /api2/json/softwareVersion Get the current software version
AdminApi SourceStats GET /api2/json/sourceStats/{source} Print basic source statistics.
AdminApi Stats GET /api2/json/stats Print basic system statistics.
AdminApi StripeConnect GET /api2/json/stripeConnect Connects a Stripe Account.
AdminApi SubscribePlan GET /api2/json/subscribePlan/{planName}/{token} Subscribe to a give API plan, using the user's preferred or default currency.
AdminApi UpdateBillingInfo POST /api2/json/updateBillingInfo/{token} Sets or update the billing information (company name, address, phone, vat ID)
AdminApi UpdateLimit GET /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit).
AdminApi UpdatePaymentDefault GET /api2/json/updatePaymentDefault/{defautSourceId}/{token} Update the default Stripe card associated with the current google auth session token.
AdminApi UserInfo GET /api2/json/userInfo/{token} Get the user profile associated with the current google auth session token.
AdminApi VerifyEmail GET /api2/json/verifyEmail/{emailToken} Verifies an email, based on token sent to that email
AdminApi VerifyRemoveEmail GET /api2/json/verifyRemoveEmail/{emailToken} Verifies an email, based on token sent to that email
AdminApi Vet GET /api2/json/vetting/{source}/{vetted} Vetting of a source.
ChineseApi ChineseNameCandidates GET /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin} Identify Chinese name candidates, based on the romanized name.
ChineseApi ChineseNameCandidatesBatch POST /api2/json/chineseNameCandidatesBatch Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname).
ChineseApi ChineseNameCandidatesGenderBatch POST /api2/json/chineseNameCandidatesGenderBatch Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname).
ChineseApi ChineseNameGenderCandidates GET /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender} Identify Chinese name candidates, based on the romanized name - having a known gender ('male' or 'female')
PersonalApi 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.
PersonalApi CountryBatch 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.
PersonalApi 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.)
PersonalApi DiasporaBatch 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.)
PersonalApi Gender GET /api2/json/gender/{firstName}/{lastName} Infer the likely gender of a name.
PersonalApi GenderBatch POST /api2/json/genderBatch Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
PersonalApi GenderFull GET /api2/json/genderFull/{fullName} Infer the likely gender of a full name, ex. John H. Smith
PersonalApi GenderFullBatch POST /api2/json/genderFullBatch Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
PersonalApi GenderFullGeo GET /api2/json/genderFullGeo/{fullName}/{countryIso2} Infer the likely gender of a full name, given a local context (ISO2 country code).
PersonalApi GenderFullGeoBatch POST /api2/json/genderFullGeoBatch Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
PersonalApi GenderGeo GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} Infer the likely gender of a name, given a local context (ISO2 country code).
PersonalApi GenderGeoBatch POST /api2/json/genderGeoBatch Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
PersonalApi 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.
PersonalApi OriginBatch POST /api2/json/originBatch [USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
PersonalApi 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.
PersonalApi ParseNameBatch POST /api2/json/parseNameBatch Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
PersonalApi 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.
PersonalApi 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.
PersonalApi ParsedGenderBatch POST /api2/json/parsedGenderBatch Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
PersonalApi ParsedGenderGeoBatch POST /api2/json/parsedGenderGeoBatch Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
PersonalApi UsRaceEthnicity 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).
PersonalApi UsRaceEthnicityBatch POST /api2/json/usRaceEthnicityBatch [USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
PersonalApi UsRaceEthnicityZIP5 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).
PersonalApi UsZipRaceEthnicityBatch 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.
SocialApi PhoneCode GET /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber} [USES 11 UNITS] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number.
SocialApi PhoneCodeBatch POST /api2/json/phoneCodeBatch [USES 11 UNITS] Infer the likely country and phone prefix, of up to 1000 personal names, detecting automatically the local context given a name and formatted / unformatted phone number.
SocialApi PhoneCodeGeo GET /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2} [USES 11 UNITS] Infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).
SocialApi PhoneCodeGeoBatch POST /api2/json/phoneCodeGeoBatch [USES 11 UNITS] Infer the likely country and phone prefix, of up to 1000 personal names, with a local context (ISO2 country of residence).
SocialApi PhoneCodeGeoFeedbackLoop GET /api2/json/phoneCodeGeoFeedbackLoop/{firstName}/{lastName}/{phoneNumber}/{phoneNumberE164}/{countryIso2} [CREDITS 1 UNIT] Feedback loop to better infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Author

contact@namsor.com

You can’t perform that action at this time.