Psydex - Technology - PQL (PSYDEX Query Language)


	AG API v1.0 (beta) • Overview • API Key Generation • Catalog • Correlations • Content • Events • Topics • Search • Sentiment • Statistics • Text Mining • Time Series • Updates Request Authorization to API

Search

Seamlessly Search real time and historical data

URLs:
http://psydex.net/api/search/topics
http://psydex.net/api/search/words
http://psydex.net/api/search/phrases
http://psydex.net/api/search/content

Search for Topics

URL:
http://psydex.net/api/search/topics

Parameters:
Required:	Valid Values
api_key	API Key provided by Psydex
criteria	Alpha-numeric String

At Least One of Following:
id	Valid Topic Id
symbol	Valid Topic Symbol (A-Za-z0-9._)
group id	Valid Topic Group Id

OPTIONAL:
sort_field	0=id Valid Sort Field Values
sort_order	0=ascValid Sort Order Values
max	1 - 100 Default 25

Response:	Response XML Schema Defintion (XSD)
Element:	Description
id	Topic ID
symbol	Topic Symbol
description	Topic Description
expression	Topic Expression
expression_unraveled	Topic Expression with nested topic symbol(s) expanded
domain	Domain's are used to logically segment topics
model_type	Type of Topic Model - 1 = Semantic, 2 = Data
user_id	Unique number assigned to the user who created / owns the topic
user_name	Unique string assigned to the user who created / owns the topic
visibility	Visibility of Topic: 0 = public, 1 = organization, 2 = private
topic_class_id	Unique number assigned to the Topic Class. A Topic may have 0 or many Topic Classes assigned.

URL:
http://psydex.net/api/search/words

Parameters:
Required:	Valid Values
api_key	API Key provided by Psydex
criteria	Alpha-numeric String

OPTIONAL:
source_id	List of Source Identifiers (Standard Financial)
sort_field	0 = id, 1 = symbol
sort_order	0 = ASC, 1 = DSC
max	1 - 100 (25)

Response:	Response XML Schema Defintion (XSD)
Element:	Description
string	word matching criteria
count	recent count for word

URL:
http://psydex.net/api/search/phrases

Parameters:
Required:	Valid Values
api_key	API Key provided by Psydex
criteria	Alpha-numeric String


OPTIONAL:
source_id	List of Source Identifiers (Standard Financial)
sort_field	0 = id, 1 = symbol
sort_order	0 = ASC, 1 = DSC
max	1 - 100 (25)

Response:	Response XML Schema Defintion (XSD)
Element:	Description
Element:	Description
string	word matching criteria
count	recent count for word

URL:
http://psydex.net/api/search/content

Restriction(s):

Parameters:
Required:	Valid Values
api_key	API Key provided by Psydex

At Least One of Following:
pql	Valid Psydex Query Language Expression (Semantic Models)
id	Valid Topic Id
symbol	Valid Topic Symbol (A-Za-z0-9._)
group id	Valid Topic Group Id

OPTIONAL:
source_id	List of Source Identifiers (Standard Financial)
begin	Epoch Timestamp for begin Default (Now())
end	Epoch Timestamp for end Default (Now()- 5 Minutes)
sort_field	7 = Time
sort_order	0 = ASC, 1 = DSC

Response:	Response XML Schema Defintion (XSD)
Element:	Description
source	List of Sources
source_qualifier	Qualifier for Source. This applies to Blogs, Twitter sources. It will be the Blog Name or Twitter User.
content_uuid	Unique Identifier for the content
pub_time	Timestamp source indicates content was published
collection_time	When content was collected by Psydex
title	Content Title. See Content request for retrieving full content and additional metadata.