Skip to content
NamSor API v2 Python SDK - classify personal names accurately by gender, country of origin, or ethnicity.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Minor update May 11, 2019
openapi_client Minor update May 11, 2019
test Minor update May 11, 2019
.gitattributes.txt openapi-generator Jan 14, 2019
.travis.yml Update .travis.yml Mar 23, 2019
LICENSE Initial commit Jan 14, 2019
README.md Minor update May 11, 2019
git_push.sh openapi-generator Jan 14, 2019
requirements.txt
run-python.bash Minor update Jan 14, 2019
setup.py openapi-generator Jan 14, 2019
test-requirements.txt openapi-generator Jan 14, 2019
tox.ini openapi-generator Jan 14, 2019

README.md

openapi-client

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!

This Python package is automatically generated by the OpenAPI Generator project:

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/namsor/namsor-python-sdk2.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/namsor/namsor-python-sdk2.git)

Then import the package:

import openapi_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = openapi_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration))
api_key = 'api_key_example' # str | 
usage_credits = 56 # int | 
user_message = 'user_message_example' # str | 

try:
    # Add usage credits to an API Key.
    api_response = api_instance.add_credits(api_key, usage_credits, user_message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->add_credits: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AdminApi add_credits GET /api2/json/addCredits/{apiKey}/{usageCredits}/{userMessage} Add usage credits to an API Key.
AdminApi api_usage GET /api2/json/apiUsage Print current API usage.
AdminApi api_usage_history GET /api2/json/apiUsageHistory Print historical API usage.
AdminApi api_usage_history_aggregate GET /api2/json/apiUsageHistoryAggregate Print historical API usage (in an aggregated view, by service, by day/hour/min).
AdminApi available_plans GET /api2/json/availablePlans/{token} List all available plans in the user's preferred currency.
AdminApi available_plans1 GET /api2/json/availablePlans List all available plans in the default currency (usd).
AdminApi available_services GET /api2/json/apiServices List of API services and usage cost in Units (default is 1=ONE Unit).
AdminApi billing_currencies GET /api2/json/billingCurrencies List possible currency options for billing (USD, EUR, GBP, ...)
AdminApi billing_history GET /api2/json/billingHistory/{token} Read the history billing information (invoices paid via Stripe or manually).
AdminApi billing_info 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 corporate_key GET /api2/json/corporateKey/{apiKey}/{corporate} Setting an API Key to a corporate status.
AdminApi debug_level GET /api2/json/debugLevel/{logger}/{level} Update debug level for a classifier
AdminApi flush GET /api2/json/flush Flush counters.
AdminApi invalidate_cache GET /api2/json/invalidateCache Invalidate system caches.
AdminApi learnable GET /api2/json/learnable/{source}/{learnable} Activate/deactivate learning from a source.
AdminApi namsor_counter GET /api2/json/namsorCounter Get the overall API counter
AdminApi payment_info GET /api2/json/paymentInfo/{token} Get the Stripe payment information associated with the current google auth session token.
AdminApi procure_key GET /api2/json/procureKey/{token} Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret.
AdminApi redeploy_ui GET /api2/json/redeployUI Redeploy UI from current dev branch.
AdminApi redeploy_ui1 GET /api2/json/redeployUI/{live} Redeploy UI from current dev branch.
AdminApi remove_user_account 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 software_version GET /api2/json/softwareVersion Get the current software version
AdminApi source_stats GET /api2/json/sourceStats/{source} Print basic source statistics.
AdminApi stats GET /api2/json/stats Print basic system statistics.
AdminApi stripe_connect GET /api2/json/stripeConnect Connects a Stripe Account.
AdminApi subscribe_plan GET /api2/json/subscribePlan/{planName}/{token} Subscribe to a give API plan, using the user's preferred or default currency.
AdminApi update_billing_info POST /api2/json/updateBillingInfo/{token} Sets or update the billing information (company name, address, phone, vat ID)
AdminApi update_limit GET /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit).
AdminApi update_payment_default GET /api2/json/updatePaymentDefault/{defautSourceId}/{token} Update the default Stripe card associated with the current google auth session token.
AdminApi user_info GET /api2/json/userInfo/{token} Get the user profile associated with the current google auth session token.
AdminApi verify_email GET /api2/json/verifyEmail/{emailToken} Verifies an email, based on token sent to that email
AdminApi verify_remove_email 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 chinese_name_candidates GET /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin} Identify Chinese name candidates, based on the romanized name.
ChineseApi chinese_name_candidates_batch POST /api2/json/chineseNameCandidatesBatch Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname).
ChineseApi chinese_name_candidates_gender_batch POST /api2/json/chineseNameCandidatesGenderBatch Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname).
ChineseApi chinese_name_gender_candidates 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 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.
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 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.)
PersonalApi gender GET /api2/json/gender/{firstName}/{lastName} Infer the likely gender of a name.
PersonalApi gender_batch POST /api2/json/genderBatch Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
PersonalApi gender_full GET /api2/json/genderFull/{fullName} Infer the likely gender of a full name, ex. John H. Smith
PersonalApi gender_full_batch POST /api2/json/genderFullBatch Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
PersonalApi gender_full_geo GET /api2/json/genderFullGeo/{fullName}/{countryIso2} Infer the likely gender of a full name, given a local context (ISO2 country code).
PersonalApi 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).
PersonalApi gender_geo GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} Infer the likely gender of a name, given a local context (ISO2 country code).
PersonalApi gender_geo_batch 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 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.
PersonalApi 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.
PersonalApi 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.
PersonalApi 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.
PersonalApi 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.
PersonalApi parsed_gender_batch POST /api2/json/parsedGenderBatch Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
PersonalApi parsed_gender_geo_batch POST /api2/json/parsedGenderGeoBatch Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
PersonalApi 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).
PersonalApi 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.
PersonalApi 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).
PersonalApi 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.
SocialApi phone_code 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 phone_code_batch 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 phone_code_geo 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 phone_code_geo_batch 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 phone_code_geo_feedback_loop 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.