Wordze Api Docs

Wordze's Application Programming Interface(API) All members have access to Wordze's API Service. With the API you can perform keyword searches and other processes in the same manner that you perform searches here in the members area via a script or program of your own design. The following documentation describes how to use the Wordze API. • • • •

Query requests are simply HTTP GET requests. Service parameters are passed as simple HTTP parameters. Query requests can be tested on any browser. The response is in the HTTP response body and is in human readable XML format.

The API is attached to your account limits that you have here in the members area. It is very important that you NEVER give out your login information for the members area or the API.

Keyword Search API: A standard keyword search query would look like the following: http://api.wordze.com/ApiSearch?ApiKey=[Your APIKey]&Query=[Keyword]&PageNum=[Page Number]&FilterType=[Filter Options]&NumResult=[Number of Results Per Page]&SearchStyle=[Search Style] Parameter ApiKey Query PageNum

FilterType

NumResult

SearchStyle CharLen

Options Enter in your unique ApiKey to gain access Keyword (All keywords should use url encoding) The page number in results to show. ie 1 would show page one, while 50 would show page fifty. 1 = None(Do not filter) 2 = Adult 3 = Drugs 4 = Gambling 5 = Warez and Hacking 6 = Filter out all (2, 3, 4, & 5) 20 = 20 keywords per page 50 = 50 keywords per page 100 = 100 keywords per page exact = Exact Match any = Any Match broad = Broad Match This option allows you to limit the length of characters in a

CountLim

keyword. CharLen=-15 will only produce results with 15 or less characters in the keyword, while CharLen=25 will only produce results with 25 or more characters in the keyword.(This includes spaces) This option allows you to limit the hit count for a keyword. CountLim=-15 will only produce results with 15 or less hits, while CountLim=100 will only produce results with 100 or more hits on the count field.

The search API will return all results in XML format. Return Parameters Description <Page>## The page number in results returned #### Total number of pages for results ###### The total number of keywords found <SearchStyle>Search Style The search style used in text format Used Filtering used The filter type you are using in text format ## The number of results shown per page Result Estimated values in the tag variables, while Keyword the keyword is shown within the node API error notices will always be returned in <Error>error notice Return Parameters No Query Entered No PageNum Entered No FilterType Entered No NumResults Entered No SearchStyle Entered

Description You did not enter in a query for the API engine You did not enter in a page number to show You did not tell it what type of filtering to use You did not tell it how many keywords to show per result (20,50,100) You did not tell it the search style to use (exact, any, broad)

Search limit exceeded

You have used up your daily search limit (see your main account area for stats)

Invalid ApiKey Account

The ApiKey that you entered is not valid

Query speed too fast No ApiKey

You are limited to how fast you can send request to the API. If you are using persistent queries, slow down the number of queries and you should be able to continuously request keywords from the API. You did not enter a ApiKey to gain access

If the system finds no results or has no data it will not return any data. Keyword Stemming Only the broad match search style offers stemming of keywords. To invoke stemming on a keyword, simply put an ^ after the keyword. Exp "kitchen remodeling^" would stem the word to "kitchen remodel" and return all results with a match from the root word "remodel". You can check your account status for how many queries you have used for the day by sending a query to: (Note: You should ONLY run this at the start of your application, and keep track until it completes) http://api.wordze.com/AccountStatus?ApiKey=[Your APIKey]

Keyword History Api To lookup any keyword history simply send the following request: http://api.wordze.com/ApiHistory?ApiKey=[Your APIKey]&Query=[Keyword]&Date=[Date in format YYYYMM] Return Parameters

Description The date tag holds the date, count, as well as, the change from the previous day, as well as Estimated for that day.

Single Keyword Lookup To lookup a single keyword search data use the following Api request(Separate terms with commas to include more than one term per query. You are limited to 500 terms per Api call): http://api.wordze.com/KeywordSingle?ApiKey=[Your APIKey]&Query=[Keyword],[Keyword],[Keyword] Return Parameters

Description The Keyword tag holds the Count for the last 30 days, as well as, the Estimated traffic levels.