This page provides an introduction to Preseries.io—The Preseries API.
Preseries.io is a REST API to query the predictions made about a Company and
manage all data related to a Company for which is the main entity in Preseries.
Preseries.io is a REST-style API for quering Preseries prediction resources
and creating and managing Preseries resources
programmatically. That is to say, using Preseries.io you can
query for predictions made on Companies and also create, retrieve, update, and delete Companies and other Preseries resources using standard HTTP methods.
Preseries.io gives you access to the following resources:
Note: In the snippets below you should substitute Alfred's username and
API key for your own username and API Key.
Preseries.io conforms to the design principles of
Representational State Transfer (REST).
Preseries.io is entirely HTTPS-based.
You can create, read, update,
and delete resources using the respective standard HTTP methods:
POST, GET, PUT and DELETE.
All communication with Preseries.io is
All access to Preseries.io must be performed over HTTPS.
In this way communication between your application and Preseries.io is encrypted and the integrity of traffic between both is verified.
All Preseries.io HTTP commands use the following base URL:
comes with a development mode
that allows you to explore Preseries API no affecting real data.
To use Preseries.io
in development mode
you just need to append /dev/
to your URLs right after the domain name and before the version name.
has a few limitations:
- Data is volatile.
- Crawlers might not be activated.
- Data can be consolidated erratically.
- Scores are fake.
API is versioned using code names instead
of version numbers. The current version name is "zion
so URLs for this version can be written to require this version as follows:
Specifying the version name is optional. If you omit the version name in your API requests, you will always get access
to the latest API version. While we will do our best to make future API versions backward compatible it is possible
that a future API release could cause your application to fail.
Specifying the API version in your HTTP calls will ensure that your application continues to function for the life cycle of the API release.
Summary of Prediction Resource URL Patterns
gives you access to the following prediction resources:
Prediction Resource URL Patterns
Summary of Resource URL Patterns
gives you access to the following resources:
Resource URL Patterns
Summary of HTTP Methods
uses the standard POST, GET, PUT, and DELETE HTTP methods to
create, retrieve, update and delete resources, respectively.
||Creates a new resource. Only certain fields are "postable". This method
is not idempotent. Each valid POST request results in a new directly accessible resource.
|| Retrieves either a specific resource or a list of resources.
This methods is idempotent. The content type of the resources is always "application/json; charset=utf-8".
||Updates partial content of a resource. Only certain fields are "putable". This method is idempotent.
||Deletes a resource. This method is idempotent.
resources are identified by a name composed of two parts separated by a slash "/".
The first part is the type of the resource and the second part is a 24-char unique identifier. See the examples below:
Example of resources Ids
are immediately assigned when a resource is
created and you can use them to retrieve, update or delete
the corresponding resource. The resource Ids
are also used as the
input parameter for the creation of dependent resources.
is currently limited to 1,000,000 (a million) requests per API key per hour.
Please email us
if you have a specific use case that requires a higher rate limit.