Last 7 days, UTC

Average Latency
36ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time

Author Extraction

HTTP 200 : HTMLGetAuthor Model GET/html/HTMLGetAuthor
						{
  "status": "ERROR",
  "statusInfo": "content-is-empty",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1",
  "author": ""
}						
HTMLGetAuthor

The HTMLGetAuthor call is utilized to extract author information contained within the specified web page. AlchemyAPI will process the posted HTML document, looking for author information.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded) (optional parameter, for response tracking purposes.)
Example: http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1

url

Optional

string

desired JSONP callback. (optional parameter, requires "outputMode" to be set to json)

jsonp

Optional

string

Example: json

outputMode

Required

HTTP 200 : URLGetAuthor Model GET/url/URLGetAuthor
						{
  "status": "OK",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1",
  "author": "the CNN Wire Staff"
}						
URLGetAuthor

The URLGetAuthor call is utilized to extract author information contained within the specified web page. AlchemyAPI will download the requested URL, process the retrieved HTML document, looking for author information.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)
Example: http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1

url

Required

string

desired JSONP callback (optional parameter, requires "outputMode" to be set to json

jsonp

Optional

string

Example: json

outputMode

Required

Concept Tagging

HTTP 200 : string GET/html/HTMLGetRankedConcepts
HTMLGetRankedConcepts

The HTMLGetRankedConcepts call is utilized to extract a relevancy-ranked list of concept tags for a posted HTML document. AlchemyAPI will extract text from the posted HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform concept tagging operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded)

url

Optional

string

maximum number of concept tags to extract (default: 8)

maxRetrieve

Optional

string

desired API output format Possible values: xml (default) json rdf

outputMode

Optional

string

desired JSONP callback (optional parameter, requires "outputMode" to be set to json)

jsonp

Optional

boolean

whether to include Linked Data content links with identified concept tags. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to include the original 'source text' the concept tags were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

HTTP 200 : TextGetRankedConcepts Model GET/text/TextGetRankedConcepts
						{
  "status": "OK",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "",
  "language": "english",
  "concepts": [
    {
      "text": "Federal Bureau of Investigation",
      "relevance": "0.950942"
    },
    {
      "text": "September 11 attacks",
      "relevance": "0.773435"
    },
    {
      "text": "Terrorism",
      "relevance": "0.714886"
    },
    {
      "text": "Law enforcement agency",
      "relevance": "0.640616"
    },
    {
      "text": "United States",
      "relevance": "0.621281"
    },
    {
      "text": "Plastic explosive",
      "relevance": "0.620733"
    },
    {
      "text": "Improvised explosive device",
      "relevance": "0.596063"
    },
    {
      "text": "Special agent",
      "relevance": "0.574926"
    }
  ]
}						
TextGetRankedConcepts

Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)
Example: (CNN) -- A 26-year-old Massachusetts man with a physics degree was arrested and charged Wednesday with plotting an attack on the Pentagon and the U.S. Capitol with a remote-controlled model aircraft, authorities said. Rezwan Ferdaus, a U.S. citizen from Ashland, Massachusetts, planned to use model aircraft filled with C-4 plastic explosives, authorities said. As a result of an undercover FBI investigation, Ferdaus, who has a physics degree from Northeastern University in Boston, was charged with attempting to provide material support and resources to al Qaeda for attacks on U.S. soldiers overseas, authorities said. His federal public defender couldn't be reached immediately for comment. A law enforcement official said Ferdaus posed no immediate danger to the public because undercover operatives kept in close contact with him. "There is no information to indicate he was connected to a foreign terrorist organization. It appears he was radicalized watching videos on the internet. He was given the opportunity to back down, but he never wavered" from his intention to carry out the attacks, the source said. Analysis: Model planes as weapons of terror The investigation also involved a cooperating witness, and authorities began recording conversations between that witness and Ferdaus in January, authorities said. Ferdaus began planning a violent "jihad" against America in early 2010, authorities said, and he began supplying the FBI undercover agents with cell phones rigged to act as electric switches for improvised explosive devices, intended to be used to kill U.S. soldiers overseas. Undercover federal agents also gave Ferdaus 25 pounds of fake C-4 explosives. Only a very small amount of it was the real thing, the source said. The FBI agents also gave Ferdaus six AK-47 assault rifles and three grenades, but they weren't functional, the source said. Between May and this month, Ferdaus also ordered and acquired a $6,500 remote-controlled aircraft, an F-86 Sabre, that he kept in a rented storage facility in Framingham, Massachusetts, that he maintained under a false name, authorities said. He also planned to use other remote-controlled models of military aircraft, authorities said. The models he planned to use are about one-tenth the size of the actual aircraft. Despite coming into possession of the plane, another law enforcement official said, "The person was never really a threat." Ferdaus is unmarried with no children, authorities said. A federal magistrate in Worcester, Massachusetts, on Wednesday ordered Ferdaus to be held until Monday, when a detention hearing is scheduled, authorities said.

text

Required

string

Text document URL (must be uri-argument encoded)

url

Optional

string

maximum number of concept tags to extract (default: 8)

maxRetrieve

Optional

string

desired JSONP callback (optional parameter, requires "outputMode" to be set to json)

jsonp

Optional

boolean

whether to include Linked Data content links with identified concept tags. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to include the original 'source text' the concept tags were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

Example: json

outputMode

Required

HTTP 200 : URLGetRankedConcepts Model GET/url/URLGetRankedConcepts
						{
  "status": "OK",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1",
  "language": "english",
  "concepts": [
    {
      "text": "Federal Bureau of Investigation",
      "relevance": "0.946449"
    },
    {
      "text": "September 11 attacks",
      "relevance": "0.749727"
    },
    {
      "text": "Terrorism",
      "relevance": "0.694086"
    },
    {
      "text": "Law enforcement agency",
      "relevance": "0.63097"
    },
    {
      "text": "Plastic explosive",
      "relevance": "0.617804"
    },
    {
      "text": "United States",
      "relevance": "0.607312"
    },
    {
      "text": "Improvised explosive device",
      "relevance": "0.590137"
    },
    {
      "text": "Special agent",
      "relevance": "0.567237"
    }
  ]
}						
URLGetRankedConcepts

The URLGetRankedConcepts call is utilized to extract a relevancy-ranked list of concept tags for a given web page. AlchemyAPI will download the requested URL, extracting text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform concept tagging operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)
Example: http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1

url

Required

string

maximum number of concept tags to extract (default: 8)

maxRetrieve

Optional

string

desired JSONP callback (optional parameter, requires "outputMode" to be set to json

jsonp

Optional

boolean

whether to include Linked Data content links with identified concept tags. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to include the original 'source text' the concept tags were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

rel-tag output base http url (must be uri-argument encoded)

baseUrl

Required

string

Example: json

outputMode

Required

Content Scraping

HTTP 200 : string GET/html/HTMLGetConstraintQuery
HTMLGetConstraintQuery

The HTMLGetConstraintQuery call is utilized to extract structured data from a posted HTML document. AlchemyAPI will analyze the posted HTML document structure, extracting the desired structured data.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded)

url

Optional

string

the constraint query to execute

cquery

Required

string

desired API output format. Possible values: xml (default), json, rdf

outputMode

Required

string

desired JSONP callback

jsonp

Required

HTTP 200 : string GET/url/URLGetConstraintQuery
URLGetConstraintQuery

The URLGetConstraintQuery call is utilized to extract structured data from a given web page. AlchemyAPI will download the requested URL, analyze the HTML document structure, and perform structured data extraction operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)
Example: http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1

url

Required

string

document constraint query
Example: Pentagon

cquery

Required

string

Desired JSONP callback

jsonp

Optional

string

Example: json

outputMode

Required

Entity Extraction

HTTP 200 : HTMLGetRankedNamedEntities Model GET/html/HTMLGetRankedNamedEntities
						{
  "status": "ERROR",
  "statusInfo": "content-is-empty",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "",
  "language": "unknown",
  "entities": []
}						
HTMLGetRankedNamedEntities

The HTMLGetRankedNamedEntities call is utilized to extract a grouped, relevancy-ranked list of named entities (people, companies, organizations, etc.) from a posted HTML document. AlchemyAPI will extract text from the posted HTML document (ignoring navigation links, advertisements, and other undesireable content), and perform entity extraction operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL

url

Optional

string

desired JSONP callback

jsonp

Optional

boolean

hether to disambiguate detected entities. Possible values: 1 - enabled (default) 0 - disabled

disambiguate

Optional

boolean

whether to include Linked Data content links with disambiguated entities. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to resolve he/she/etc coreferences into detected entities. Possible values: 1 - enabled (default) 0 - disabled

coreference

Optional

boolean

whether to enable quotations extraction. Possible values: 1 - enabled 0 - disabled (default)

quotations

Optional

boolean

whether to enable entity-level sentiment analysis. Possible values: 1 - enabled 0 - disabled (default)

sentiment

Optional

boolean

whether to include the original 'source text' the entities were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

maximum number of named entities to extract (default: 50)

maxRetrieve

Optional

string

rel-tag output base http url

baseUrl

Optional

string

Example: json

outputMode

Required

HTTP 200 : TextGetRankedNamedEntities Model GET/text/TextGetRankedNamedEntities
						{
  "status": "ERROR",
  "statusInfo": "content-is-empty",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "",
  "language": "unknown",
  "entities": []
}						
TextGetRankedNamedEntities

The TextGetRankedNamedEntities call is utilized to extract a grouped, ranked list of named entities (people, companies, organizations, etc.) from within a posted text document.


Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)

text

Required

string

Text document URL

url

Optional

string

Desired JSONP callback

jsonp

Optional

boolean

whether to disambiguate detected entities. Possible values: 1 - enabled (default) 0 - disabled

disambiguate

Optional

boolean

whether to include Linked Data content links with disambiguated entities. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to resolve he/she/etc coreferences into detected entities. Possible values: 1 - enabled (default) 0 - disabled

coreference

Optional

boolean

whether to enable quotations extraction. Possible values: 1 - enabled 0 - disabled (default)

quotations

Optional

boolean

whether to enable entity-level sentiment analysis. Possible values: 1 - enabled 0 - disabled (default)

sentiment

Optional

boolean

whether to include the original 'source text' the entities were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

maximum number of named entities to extract (default: 50)

maxRetrieve

Required

string

rel-tag output base http url (optional parameter, used with rel-tag or rel-tag-raw outputMode. must be uri-argument encoded)

baseUrl

Required

string

Example: json

outputMode

Required

HTTP 200 : string GET/url/URLGetRankedNamedEntities
URLGetRankedNamedEntities

The URLGetRankedNamedEntities call is utilized to extract a grouped, relevancy-ranked list of named entities (people, companies, organizations, etc.) from a given web page. AlchemyAPI will download the requested URL, extracting text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform entity extraction operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

string

Desired JSONP callback

jsonp

Optional

boolean

whether to disambiguate detected entities. Possible values: 1 - enabled (default) 0 - disabled

disambiguate

Optional

boolean

whether to include Linked Data content links with disambiguated entities. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to resolve he/she/etc coreferences into detected entities. Possible values: 1 - enabled (default) 0 - disabled

coreference

Optional

boolean

whether to enable quotations extraction. Possible values: 1 - enabled 0 - disabled (default)

quotations

Optional

boolean

whether to enable entity-level sentiment analysis. Possible values: 1 - enabled 0 - disabled (default)

sentiment

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

boolean

whether to include the original 'source text' the entities were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product descriptio

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

maximum number of named entities to extract (default: 50)

maxRetrieve

Optional

string

rel-tag output base http url (optional parameter, used with rel-tag or rel-tag-raw outputMode. must be uri-argument encoded)

baseUrl

Optional

string

Example: json

outputMode

Required

Keyword/Term Extraction

HTTP 200 : HTMLGetRankedKeywords Model GET/html/HTMLGetRankedKeywords
						{
  "status": "ERROR",
  "statusInfo": "content-is-empty",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "",
  "language": "unknown",
  "keywords": []
}						
HTMLGetRankedKeywords

The HTMLGetRankedKeywords call is utilized to extract a relevancy-ranked list of topic keywords from a posted HTML document. AlchemyAPI will extract text from the posted HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform keyword extraction operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded)

url

Optional

string

maximum number of keywords to extract (default: 50)

maxRetrieve

Optional

string

keyword extraction mode (normal or strict) Possible values: normal - normal keyword extraction mode (default) strict - strict keyword extraction mode (returns more "well-formed" keywords). refines results at the expense of returning fewer keywords.

keywordExtractMode

Optional

boolean

whether to enable keyword-level sentiment analysis. Possible values: 1 - enabled 0 - disabled (default)

sentiment

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the keywords were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

rel-tag output base http url (must be uri-argument encoded)

baseUrl

Optional

string

Example: json

outputMode

Required

HTTP 200 : TextGetRankedKeywords Model GET/text/TextGetRankedKeywords
						{
  "status": "ERROR",
  "statusInfo": "content-is-empty",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "",
  "language": "unknown",
  "keywords": []
}						
TextGetRankedKeywords

The TextGetRankedKeywords call is utilized to extract a relevancy-ranked list of topic keywords from within a posted text document.


Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)

text

Required

string

Text document URL (must be uri-argument encoded)

url

Optional

string

maximum number of keywords to extract (default: 50)

maxRetrieve

Optional

string

keyword extraction mode (normal or strict) Possible values: normal - normal keyword extraction mode (default) strict - strict keyword extraction mode (returns more "well-formed" keywords). refines results at the expense of returning fewer keywords.

keywordExtractMode

Optional

boolean

whether to enable keyword-level sentiment analysis. Possible values: 1 - enabled 0 - disabled (default)

sentiment

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the keywords were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

rel-tag output base http url (must be uri-argument encoded)

baseUrl

Optional

string

Example: json

outputMode

Required

HTTP 200 : URLGetRankedKeywords Model GET/url/URLGetRankedKeywords
						{
  "status": "OK",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1",
  "language": "english",
  "keywords": [
    {
      "text": "authorities",
      "relevance": "0.953573"
    },
    {
      "text": "Ferdaus",
      "relevance": "0.806639"
    },
    {
      "text": "law enforcement official",
      "relevance": "0.669356"
    },
    {
      "text": "physics degree",
      "relevance": "0.571233"
    },
    {
      "text": "U.S. soldiers",
      "relevance": "0.55418"
    },
    {
      "text": "model aircraft",
      "relevance": "0.54481"
    },
    {
      "text": "undercover FBI investigation",
      "relevance": "0.531536"
    },
    {
      "text": "remote-controlled model aircraft",
      "relevance": "0.529597"
    },
    {
      "text": "FBI undercover agents",
      "relevance": "0.515624"
    },
    {
      "text": "26-year-old Massachusetts man",
      "relevance": "0.514358"
    },
    {
      "text": "C-4 plastic explosives",
      "relevance": "0.508845"
    },
    {
      "text": "Undercover federal agents",
      "relevance": "0.507254"
    },
    {
      "text": "foreign terrorist organization",
      "relevance": "0.497881"
    },
    {
      "text": "federal public defender",
      "relevance": "0.497196"
    },
    {
      "text": "fake C-4 explosives",
      "relevance": "0.493376"
    },
    {
      "text": "AK-47 assault rifles",
      "relevance": "0.492042"
    },
    {
      "text": "undercover operatives",
      "relevance": "0.47533"
    },
    {
      "text": "remote-controlled aircraft",
      "relevance": "0.467004"
    },
    {
      "text": "Rezwan Ferdaus",
      "relevance": "0.466827"
    },
    {
      "text": "remote-controlled models",
      "relevance": "0.463457"
    },
    {
      "text": "al Qaeda",
      "relevance": "0.461137"
    },
    {
      "text": "U.S. Capitol",
      "relevance": "0.458488"
    },
    {
      "text": "U.S. citizen",
      "relevance": "0.457902"
    },
    {
      "text": "material support",
      "relevance": "0.45666"
    },
    {
      "text": "Northeastern University",
      "relevance": "0.455215"
    },
    {
      "text": "FBI agents",
      "relevance": "0.454931"
    },
    {
      "text": "immediate danger",
      "relevance": "0.452742"
    },
    {
      "text": "F-86 Sabre",
      "relevance": "0.452636"
    },
    {
      "text": "federal magistrate",
      "relevance": "0.452123"
    },
    {
      "text": "close contact",
      "relevance": "0.450936"
    },
    {
      "text": "explosive devices",
      "relevance": "0.450537"
    },
    {
      "text": "Model planes",
      "relevance": "0.450393"
    },
    {
      "text": "real thing",
      "relevance": "0.44948"
    },
    {
      "text": "electric switches",
      "relevance": "0.449029"
    },
    {
      "text": "military aircraft",
      "relevance": "0.448853"
    },
    {
      "text": "source",
      "relevance": "0.448829"
    },
    {
      "text": "cell phones",
      "relevance": "0.448538"
    },
    {
      "text": "actual aircraft",
      "relevance": "0.447706"
    },
    {
      "text": "storage facility",
      "relevance": "0.447557"
    },
    {
      "text": "Michael Martinez",
      "relevance": "0.447419"
    },
    {
      "text": "detention hearing",
      "relevance": "0.447397"
    },
    {
      "text": "Carol Cratty",
      "relevance": "0.446094"
    },
    {
      "text": "attacks",
      "relevance": "0.430211"
    },
    {
      "text": "CNN",
      "relevance": "0.429348"
    },
    {
      "text": "Wednesday",
      "relevance": "0.428269"
    },
    {
      "text": "witness",
      "relevance": "0.422471"
    },
    {
      "text": "one-tenth",
      "relevance": "0.412881"
    },
    {
      "text": "Pentagon",
      "relevance": "0.411496"
    },
    {
      "text": "grenades",
      "relevance": "0.411314"
    },
    {
      "text": "intention",
      "relevance": "0.409761"
    }
  ]
}						
URLGetRankedKeywords

The URLGetRankedKeywords call is utilized to extract a relevancy-ranked list of topic keywords from a given web page. AlchemyAPI will download the requested URL, extracting text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform keyword extraction operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)
Example: http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1

url

Required

string

maximum number of keywords to extract (default: 50)

maxRetrieve

Optional

string

keyword extraction mode (normal or strict) Possible values: normal - normal keyword extraction mode (default) strict - strict keyword extraction mode (returns more "well-formed" keywords). refines results at the expense of returning fewer keywords.

keywordExtractMode

Optional

boolean

whether to enable keyword-level sentiment analysis. Possible values: 1 - enabled 0 - disabled (default)

sentiment

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the keywords were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

rel-tag output base http url (must be uri-argument encoded)

baseUrl

Optional

string

Example: json

outputMode

Required

Language Detection

HTTP 200 : string GET/html/HTMLGetLanguage
HTMLGetLanguage

The HTMLGetLanguage call is utilized to detect the language utilized within a posted HTML document. AlchemyAPI will extract text from the posted HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform language detection operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (optional parameter, for response tracking purposes. must be uri-argument encoded)

url

Required

string

desired JSONP callback

jsonp

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

Example: jsonp

outputMode

Required

HTTP 200 : TextGetLanguage Model GET/text/TextGetLanguage
						{
  "status": "ERROR",
  "statusInfo": "not-enough-text-for-language-id",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "",
  "language": "unknown"
}						
TextGetLanguage

The TextGetLanguage call is utilized to detect the language utilized within a posted text document.


Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)

text

Required

string

Text document url

url

Optional

string

desired JSONP callback

jsonp

Optional

string

Example: json

outputMode

Required

HTTP 200 : string GET/url/URLGetLanguage
URLGetLanguage

The URLGetLanguage call is utilized to detect the language utilized within a given web page. AlchemyAPI will download the requested URL, extracting text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform language detection operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

string

desired JSONP callback

jsonp

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

Example: json

outputMode

Required

Microformats

HTTP 200 : HTMLGetMicroformatData Model GET/html/HTMLGetMicroformatData
						{
  "status": "ERROR",
  "statusInfo": "invalid-url"
}						
HTMLGetMicroformatData

The HTMLGetMicroformatData call is utilized to extract Microformats content from a posted HTML document. AlchemyAPI will process the posted HTML document, looking for a variety of Microformats data structures (hCards, geo, adr, etc.).


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded) (optional parameter, for response tracking purposes.)

url

Optional

string

desired JSONP callback

jsonp

Optional

string

Example: json

outputMode

Required

HTTP 200 : URLGetMicroformatData Model GET/url/URLGetMicroformatData
						{
  "status": "OK",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1",
  "microformats": []
}						
URLGetMicroformatData

The URLGetMicroformatData call is utilized to extract structured microformats data from a given web page. AlchemyAPI will retrieve the requested URL, process the retrieved HTML document, and look for a variety of Microformats data structures (hCards, geo, adr, etc.).


Test console
Description
Parameter
string

http url (must be uri-argument encoded)
Example: http://www.cnn.com/2011/09/28/us/massachusetts-pentagon-plot-arrest/index.html?hpt=hp_t1

url

Required

string

desired JSONP callback

jsonp

Optional

string

Example: json

outputMode

Required

RSS/ATOM

Relation Extraction

HTTP 200 : HTMLGetRelations Model GET/html/HTMLGetRelations
						{
  "status": "ERROR",
  "statusInfo": "content-is-empty",
  "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
  "url": "",
  "language": "unknown",
  "relations": []
}						
HTMLGetRelations

The URLGetRelations call is utilized to extract Subject-Action-Object relations from a posted HTML document. AlchemyAPI will extract text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform relation extraction operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (optional parameter, must be uri-argument encoded)

url

Optional

number

maximum number of relations to extract (default: 50, maximum: 100)

maxRetrieve

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to enable directional sentiment analysis. Possible values: 1 - enabled 0 - disabled (default) (optional parameter - Note that enabling this option will incur usage of one (1) additional AlchemyAPI transaction)

sentiment

Optional

boolean

whether to enable relation subject/object entity extraction. Possible values: 1 - enabled 0 - disabled (default)

entities

Optional

boolean

whether to only show extracted relations that contain at least one named entity, ignoring relations containing no entities. Possible values: 1 - enabled 0 - disabled (default)

requireEntities

Optional

boolean

whether to exclude relation subject/object named entity text from sentiment processing. (For example, not analyzing "New" in "New York") Possible values: 1 - enabled (default) 0 - disabled

sentimentExcludeEntities

Optional

boolean

whether to disambiguate detected relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

disambiguate

Optional

boolean

whether to include Linked Data content links with identified relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to resolve he/she/etc coreferences in detected relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

coreference

Optional

boolean

whether to include the original 'source text' the relations were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Required

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Required

string

rel-tag output base http url (must be uri-argument encoded)

baseUrl

Required

string

Example: json

outputMode

Required

HTTP 200 : string GET/text/TextGetRelations
TextGetRelations

The TextGetRelations call is utilized to extract Subject-Action-Object relations from a given text document.


Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)

text

Required

string

Text document url (must be uri-argument encoded)

url

Optional

string

maximum number of relations to extract (default: 50, maximum: 100)

maxRetrieve

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to enable directional sentiment analysis. Possible values: 1 - enabled 0 - disabled (default) (optional parameter - Note that enabling this option will incur usage of one (1) additional AlchemyAPI transaction)

sentiment

Optional

boolean

whether to enable relation subject/object entity extraction. Possible values: 1 - enabled 0 - disabled (default) (optional parameter - Note that enabling this option will incur usage of one (1) additional AlchemyAPI transaction)

entities

Optional

boolean

whether to only show extracted relations that contain at least one named entity, ignoring relations containing no entities. Possible values: 1 - enabled 0 - disabled (default)

requireEntities

Optional

boolean

whether to exclude relation subject/object named entity text from sentiment processing. (For example, not analyzing "New" in "New York") Possible values: 1 - enabled (default) 0 - disabled

sentimentExcludeEntities

Optional

boolean

whether to disambiguate detected relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

disambiguate

Optional

boolean

whether to include Linked Data content links with identified relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to resolve he/she/etc coreferences in detected relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

coreference

Optional

boolean

whether to include the original 'source text' the relations were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

rel-tag output base http url (must be uri-argument encoded)

baseUrl

Optional

string

Example: jsonp

outputMode

Required

HTTP 200 : URLGetRelations Model GET/url/URLGetRelations
						{
  "status": "ERROR",
  "statusInfo": "invalid-url"
}						
URLGetRelations

The URLGetRelations call is utilized to extract Subject-Action-Object relations from a given web page. AlchemyAPI will download the requested URL, extracting text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform relation extraction operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

string

maximum number of relations to extract (default: 50, maximum: 100)

maxRetrieve

Required

string

desired JSONP callback

jsonp

Optional

boolean

whether to enable directional sentiment analysis. Possible values: 1 - enabled 0 - disabled (default) (optional parameter - Note that enabling this option will incur usage of one (1) additional AlchemyAPI transaction)

sentiment

Optional

boolean

whether to enable relation subject/object entity extraction. Possible values: 1 - enabled 0 - disabled (default) (optional parameter - Note that enabling this option will incur usage of one (1) additional AlchemyAPI transaction)

entities

Optional

boolean

whether to only show extracted relations that contain at least one named entity, ignoring relations containing no entities. Possible values: 1 - enabled 0 - disabled (default)

requireEntities

Optional

boolean

whether to exclude relation subject/object named entity text from sentiment processing. (For example, not analyzing "New" in "New York") Possible values: 1 - enabled (default) 0 - disabled

sentimentExcludeEntities

Optional

boolean

whether to disambiguate detected relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

disambiguate

Optional

boolean

whether to include Linked Data content links with identified relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

linkedData

Optional

boolean

whether to resolve he/she/etc coreferences in detected relation subject/object named entities. Possible values: 1 - enabled (default) 0 - disabled

coreference

Optional

boolean

whether to include the original 'source text' the relations were extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

rel-tag output base http url (must be uri-argument encoded)

baseUrl

Optional

string

Example: json

outputMode

Required

Sentiment Analysis

HTTP 200 : string GET/html/HTMLGetTargetedSentiment
HTMLGetTargetedSentiment

The HTMLGetTargetedSentiment call is utilized to extract positive/negative sentiment targeted towards a specific user-specified target phrase inside the text of a posted HTML document. AlchemyAPI will extract text from the posted HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform sentiment analysis operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

target phrase (must be uri-argument encoded) - sentiment targeted towards this phrase will be extracted from the text

target

Required

string

HTML document URL (must be uri-argument encoded)

url

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the sentiment was extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

Example: json

outputMode

Required

HTTP 200 : string GET/html/HTMLGetTextSentiment
HTMLGetTextSentiment

The HTMLGetTextSentiment call is utilized to extract positive/negative sentiment from a posted HTML document. AlchemyAPI will extract text from the posted HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform sentiment analysis operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded)

url

Required

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the sentiment was extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

Example: json

outputMode

Required

HTTP 200 : string GET/text/TextGetTargetedSentiment
TextGetTargetedSentiment

The TextGetTargetedSentiment call is utilized to extract positive/negative sentiment targeted towards a user-specified phrase within a posted text document.


Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)

text

Required

string

target phrase (must be uri-argument encoded) - sentiment targeted towards this phrase will be extracted from the text

target

Required

string

Text document URL (must be uri-argument encoded)

url

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the sentiment was extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

Example: json

outputMode

Required

HTTP 200 : string GET/text/TextGetTextSentiment
TextGetTextSentiment

The TextGetTextSentiment call is utilized to extract positive/negative sentiment from within a posted text document.


Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)

text

Required

string

Text document URL (must be uri-argument encoded)

url

Optional

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the sentiment was extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Required

string

Example: json

outputMode

Required

HTTP 200 : string GET/url/URLGetTargetedSentiment
URLGetTargetedSentiment

The URLGetTargetedSentiment call is utilized to extract positive / negative sentiment targeted towards a specific user-specified target phrase inside the text of a given web page. AlchemyAPI will download the requested URL, extracting text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform sentiment extraction operations.


Test console
Description
Parameter
string

target phrase (must be uri-argument encoded) - sentiment targeted towards this phrase will be extracted from the text

target

Required

string

http url (must be uri-argument encoded)

url

Required

string

desired JSONP callback

jsonp

Required

boolean

whether to include the original 'source text' the sentiment was extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

Example: json

outputMode

Required

HTTP 200 : string GET/url/URLGetTextSentiment
URLGetTextSentiment

The URLGetTextSentiment call is utilized to extract positive/negative sentiment from a given web page. AlchemyAPI will download the requested URL, extracting text from the HTML document structure (ignoring navigation links, advertisements, and other undesireable content), and perform sentiment extraction operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

string

desired JSONP callback

jsonp

Optional

boolean

whether to include the original 'source text' the sentiment was extracted from within the API response. Possible values: 1 - enabled 0 - disabled (default)

showSourceText

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads/nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

Example: json

outputMode

Required

Text Categorization

HTTP 200 : string GET/html/HTMLGetCategory
HTMLGetCategory

The HTMLGetCategory call is utilized to categorize a posted HTML document. AlchemyAPI will extract text and other important content from the posted HTML document structure and perform document categorization operations.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded)

url

Optional

string

desired API output format. Possible values: xml (default), json, rdf, rel-tag, rel-tag-raw
Example: json

outputMode

Required

string

desired JSONP callback

jsonp

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

sourceText

Optional

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Optional

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Optional

string

rel-tag output base http url

baseUrl

Optional

HTTP 200 : string GET/text/TextGetCategory
TextGetCategory

The TextGetCategory call is utilized to categorize posted text document.


Test console
Description
Parameter
string

Text document content (must be uri-argument encoded)

text

Required

string

Text document URL (must be uri-argument encoded)

url

Optional

string

desired JSONP callback

jsonp

Optional

string

rel-tag output base http url

baseUrl

Optional

string

Example: json

outputMode

Required

HTTP 200 : string GET/url/URLGetCategory
URLGetCategory

The URLGetCategory call is utilized to categorize a webpage. AlchemyAPI will download the requested URL, extracting text and other important content from the HTML document structure, and perform document categorization operations.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

string

desired JSONP callback

jsonp

Optional

string

where to obtain the text that will be processed by this API call. AlchemyAPI supports multiple modes of text extraction: web page cleaning (removes ads, navigation links, etc.), raw text extraction (processes all web page text, including ads/nav links), visual constraint queries, and XPath queries.

sourceText

Required

string

a visual constraints query to apply to the web page. Constraint queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

cquery

Required

string

an XPath query to apply to the web page. XPath queries enable API operations to be performed on a targeted area of a web page, such as a story title or product description.

xpath

Required

string

rel-tag output base http url

baseUrl

Required

string

Example: json

outputMode

Required

Text Extraction

HTTP 200 : string GET/html/HTMLGetRawText
HTMLGetRawText

The HTMLGetRawText call is utilized to extract all text from a posted web page. AlchemyAPI will extract text from the posted HTML document structure, including page navigation, advertisements, and other page content. To ignore this content, please use the HTMLGetText call.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded)

url

Required

string

desired API output format Possible values: xml (default) json rdf
Example: json

outputMode

Required

HTTP 200 : string GET/html/HTMLGetText
HTMLGetText

Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

HTML document URL (must be uri-argument encoded) (optional parameter, for response tracking purposes.)

url

Optional

string

whether to use description information embedded in web page meta-data Possible values: 1 - enable (default) 0 - disable

useMetadata

Required

string

whether to include hyperlinks in the extracted web page text Possible values: 1 - enable 0 - disable (default)

extractLinks

Required

string

desired API output format Possible values: xml (default) json rdf
Example: json

outputMode

Required

string

desired JSONP callback

jsonp

Required

HTTP 200 : string GET/html/HTMLGetTitle
HTMLGetTitle

The HTMLGetTitle call is utilized to extract title information from a posted web page. The posted HTML document is processed, extracting any title information.


Test console
Description
Parameter
string

HTML document content (must be uri-argument encoded)

html

Required

string

uri-argument encoded http url (optional parameter)

url

Optional

string

whether to use title information embedded in web page meta-data Possible values: 1 - enable (default) 0 - disable

useMetadata

Optional

string

desired API output format Possible values: xml (default) json rdf

outputMode

Required

HTTP 200 : string GET/url/URLGetRawText
URLGetRawText

The URLGetRawText call is utilized to extract all text from a web page. AlchemyAPI will download the requested URL, extract text from the HTML document structure, including page navigation, advertisements, and other page content. To ignore this content, please use the URLGetText call.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

string

Example: json

outputMode

Required

HTTP 200 : string GET/url/URLGetText
URLGetText

The URLGetText call is utilized to extract the primary page / article text from a web page. AlchemyAPI will download the requested URL, extract text from the HTML document structure, and ignore page navigation, advertisements, and other undesireable page content.


Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

boolean

whether to use description information embedded in web page meta-data Possible values: 1 - enable (default) 0 - disable

useMetadata

Optional

boolean

whether to include hyperlinks in the extracted web page text Possible values: 1 - enable 0 - disable (default)

extractLinks

Optional

string

desired JSONP callback

jsonp

Required

string

Example: json

outputMode

Required

HTTP 200 : string GET/url/URLGetTitle
URLGetTitle

Test console
Description
Parameter
string

http url (must be uri-argument encoded)

url

Required

string

whether to use title information embedded in web page meta-data Possible values: 1 - enable (default) 0 - disable

useMetadata

Required

string

desired API output format Possible values: xml (default) json rdf
Example: json

outputMode

Required

Consume this API completely for free!


By joining the mashape API marketplace you can start using AlchemyAPI API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.