GeneralApi.md

NamSorApiV2.GeneralApi

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

Method	HTTP request	Description
nameType	GET /api2/json/nameType/{properNoun}	Infer the likely type of a proper noun (personal name, brand name, place name etc.)
nameTypeBatch	POST /api2/json/nameTypeBatch	Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
nameTypeGeo	GET /api2/json/nameTypeGeo/{properNoun}/{countryIso2}	Infer the likely type of a proper noun (personal name, brand name, place name etc.)
nameTypeGeoBatch	POST /api2/json/nameTypeGeoBatch	Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)

nameType

ProperNounCategorizedOut nameType(properNoun)

Infer the likely type of a proper noun (personal name, brand name, place name etc.)

Example

var NamSorApiV2 = require('nam_sor_api_v2');
var defaultClient = NamSorApiV2.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new NamSorApiV2.GeneralApi();
var properNoun = "properNoun_example"; // String | 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.nameType(properNoun, callback);

Parameters

Name	Type	Description	Notes
properNoun	String

Return type

ProperNounCategorizedOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

nameTypeBatch

BatchProperNounCategorizedOut nameTypeBatch(opts)

Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)

Example

var NamSorApiV2 = require('nam_sor_api_v2');
var defaultClient = NamSorApiV2.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new NamSorApiV2.GeneralApi();
var opts = {
  'batchNameIn': new NamSorApiV2.BatchNameIn() // BatchNameIn | A list of proper names
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.nameTypeBatch(opts, callback);

Parameters

Name	Type	Description	Notes
batchNameIn	BatchNameIn	A list of proper names	[optional]

Return type

BatchProperNounCategorizedOut

Authorization

api_key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

nameTypeGeo

ProperNounCategorizedOut nameTypeGeo(properNoun, countryIso2)

Infer the likely type of a proper noun (personal name, brand name, place name etc.)

Example

var NamSorApiV2 = require('nam_sor_api_v2');
var defaultClient = NamSorApiV2.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new NamSorApiV2.GeneralApi();
var properNoun = "properNoun_example"; // String | 
var countryIso2 = "countryIso2_example"; // String | 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.nameTypeGeo(properNoun, countryIso2, callback);

Parameters

Name	Type	Description	Notes
properNoun	String
countryIso2	String

Return type

ProperNounCategorizedOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

nameTypeGeoBatch

BatchProperNounCategorizedOut nameTypeGeoBatch(opts)

Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)

Example

var NamSorApiV2 = require('nam_sor_api_v2');
var defaultClient = NamSorApiV2.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new NamSorApiV2.GeneralApi();
var opts = {
  'batchNameGeoIn': new NamSorApiV2.BatchNameGeoIn() // BatchNameGeoIn | A list of proper names
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.nameTypeGeoBatch(opts, callback);

Parameters

Name	Type	Description	Notes
batchNameGeoIn	BatchNameGeoIn	A list of proper names	[optional]

Return type

BatchProperNounCategorizedOut

Authorization

api_key

HTTP request headers

• Content-Type: application/json
• Accept: application/json