DocoDoco

日本語

REST API

The results of the access test can be obtained in XML or JSON. You can easily use it via server-side programs such as PHP or PERL.
In addition, an IP address can be searched by assigning the IP address to the parameter.

Request URL


http://api.docodoco.jp/v5/search?Parameter name=Parameters Value…

Request Parameters

Parameter names ​​and parameter values are case-sensitive.
Remarks:If there is no specification of the parameter, it will be "a default value".

REST API Request Parameters
Parameter name Description Value Initial value
Key1 API Key1 alphanumeric characters ※required
Key2 API Key2 alphanumeric characters ※required
format Response format specification xml,json xml
charset Character code specification at the time of response jis,sjis,eucjp,utf8 utf8
ipadr IP address specification you want to test 0.0.0.0~255.255.255.255 IP address of the access source

Return Parameter

Remarks: There’s no warranty for the order of XML tag. Please avoid using a data acquisition method relying on tag’s order.
The following values ​​are shown based on the information of the environment currently being accessed.

Basic parameter

Following is a list of data acquired as default when using DocoDoco.
Please refer to the third party data for the optional data.

REST API –Table of basic parameter
Data Function name Description Value
Country ContinentCode Get a matching Continenty code. Loading...
CountryCode Get a matching country code. Loading...
CountryAName Get a matching country English name. Loading...
CountryJName Get a matching country Japanese name. Loading...
Prefecture RegionCode Get a matching region Japanese name. Loading...
PrefCode Get a matching prefecture Japanese name. Loading...
PrefAName Get a matching prefecture name. Loading...
PrefJName Get a matching prefecture Japanese name. Loading...
PrefLatitude Get a latitude. Loading...
PrefLongitude Get a longitude. Loading...
Municipality CityCode Get a matching city code. Loading...
CityAName Get a matching city English name. Loading...
CityJName Get a matching city Japanese name. Loading...
CityLatitude Get a latitude. Loading...
CityLongitude Get a longitude. Loading...
Organization BCFlag Get a company flag. Loading...
OrgCode Get a matching organization code. Loading...
OrgOfficeCode Get a matching pmain/branch office flag. Loading...
OrgIndependentCode Get a matching self-employed business flag. Loading...
OrgName Get a matching organization name. Loading...
OrgPrefCode Get a matching prefecture code. Loading...
OrgCityCode Get a matching city code. Loading...
OrgLatitude Get a latitude. Loading...
OrgLongitude Get a longitude. Loading...
OrgZipCode Get a matching company zipcode. Loading...
OrgAddress Get a matching company address. Loading...
OrgTel Get a matching Telephone number. Loading...
OrgFax Get a matching FAX number. Loading...
OrgIpoType Get a matching listing classification flag. Loading...
StockTickerNumber Get a matching stock ticker code. Loading...
OrgDate Get a matching date of the establishment. Loading...
OrgCapitalCode Get a matching capital code. Loading...
OrgEmployeesCode Get a matchingpayroll number code. Loading...
OrgGrossCode Get a matching sales amount code. Loading...
OrgPresident Get a matching the name of the president. Loading...
OrgIndustrialCategoryL Get a matching organization industrial category large classification. Loading...
OrgIndustrialCategoryM Get a matching organization industrial category meddle classification. Loading...
OrgIndustrialCategoryS Get a matching organization industrial category small classification. Loading...
OrgIndustrialCategoryT Get a matching organization industrial category fine classification. Loading...
OrgUrl Get a matching organization URL. Loading...
OrgDomainName Get a matching organization domain name.(based on the Organization data) Loading...
DomainType Get a matching domain type.(based on the IP data) Loading...
OrgEnglishName Get a matching organization name in English. Loading...
OrgEnglishAddress Get a matching organization address in English. Loading...
Environment IP Get a matching IP address. Loading...
LineCode Get a matching line code. Loading...
LineJName Get a matching line Japanese name. Loading...
TimeZone Get a matching tel timezone. Loading....
TelCode Get a matching tel code.(based on the Organization data) Loading...
DomainName Get a matching domain name.(based on the IP) Loading...
ProxyFlag Get a proxy flag. Loading...
EncryptedIP Get a letter string of encrypted IP address. Loading...
Confidence Facter(CF) PrefCF Get a matching prefecture JCF value. Loading...
CityCF Get a matching city CF value. Loading...
LineCF Get a matching line CF value. Loading...


Third party data

Following data is provided as an option of DocoDoco. Please proceed to enable data acquisition at the administrative screen of DocoDoco when using. Please refer to the corporate number(Japanese page) related data for details.

Return parameter of the third party data is expanded as a child element in the corresponding element (property). You can check the sample of response at the administrative screen of DocoDoco.

REST API – Table of return parameter of third party data
Data Function name Description Value
corporate number HoujinBangou Get a corporate number Loading...
HoujinName Get a trade name or name
(based on corporate number)
Loading...
HoujinAddress Get a address of headquarter
(based on corporate number)
Loading...
HoujinLastUpdate Get a last update for corporate number related data Loading...


Result

Please check the DEMO data.

REST API Error

If an error occurs, the following information will be returned.

REST API Error
Type Status Message Detail
Authentication 401 Unauthorized APIキーの認証に失敗
It is failed by the certification of the API key

Unauthorizedの場合

<?xml version="1.0" encoding="utf-8"?><docodoco><status>401</status><message>Unauthorized</message></docodoco>

Page Top