How to access the API:

  1. Authentication
    The authentication used for this Web API is Basic Authentication. The same credentials are used as the "Trendstop" website.
    See Basic access authentication (on wikipedia) for more information.

    If no credentials are supplied using the Authorization header or the credentials are incorrect, the HTTP status code 401 (Unauthorized) will be returned.
  2. API Key
    Every request must contain the X-AuthKey header with the key for your application.
    Alternatively you can add the key to the querystring, the name should be AuthKey.
    Contact Biblo for information about obtaining a key.

    If no key is supplied or the key is invalid the HTTP status code 403 (Forbidden) will be returned.
  3. Client
    To test this web API, you can use Postman - REST Client for Google Chrome, the RESTClient for Firefox, Fiddler for Windows or any other REST/HTTP client. Don't forget to set the authentication and the API key headers.

Available Resources

List Data

These lists should be stored within you application and fetched only when a value is missing from retrieved company data (ie new sector or figure code).

  • GET https://webapi.trendstop.be/api1/sectorlist
    List of Trendstop Sectors.
  • GET https://webapi.trendstop.be/api1/nacebellist
    List of Nacebel.
  • GET https://webapi.trendstop.be/api1/figurelist
    List of available figures.
  • GET https://webapi.trendstop.be/api1/functionlist
    List of functions for the management.
Company Details

Returns 404 when company data is not available in Trendstop.

  • GET https://webapi.trendstop.be/api1/company/vat
    Company details with vat parameter (ie 439307357 for Biblo).
    Rating is expressed as a value from 1 to 5; or null if unknown.
  • GET https://webapi.trendstop.be/api1/company/vat/ranking
    Ranking by turnover and added value in country and in sector.
  • GET https://webapi.trendstop.be/api1/company/vat/management
    Management: board members and executives.
  • GET https://webapi.trendstop.be/api1/company/vat/figures
    Key figures (possible data).
  • GET https://webapi.trendstop.be/api1/company/vat/ratios
    Ratios (possible data).
  • GET https://webapi.trendstop.be/api1/company/vat/social
    Social balance sheet (possible data).
Search Company / Companies

The maximum number of results returned is 20.

  • GET https://webapi.trendstop.be/api1/companies/?who=who
    Search for companies by name.
  • GET https://webapi.trendstop.be/api1/companies/?who=who&where=where
    Search for companies by name at the given location (postalcode or city).
Credits
  • GET https://webapi.trendstop.be/api1/credits
    Get the remaining credit count (and total initial credits).
  • POST https://webapi.trendstop.be/api1/credits/count
    Consume count credit(s). Will return the remaining credit count.
Rate limit
  • GET https://webapi.trendstop.be/api1/ratelimit
    Get current API usage rate limit.

Guidelines

Content

The Accept header is used to determine the media type for the response. This header is optional, and if ommited then JSON is return.

  • application/json for JSON
  • application/xml for XML

Alternatively you can add the extension .json or .xml to the request. Example of getting sectorlist as json: /api1/sectorlist.json

Language

The Accept-Language header is used to determine the language. Querystring parameter l can also be used. These 3 language codes are accepted:

  • NL for Dutch
  • FR for French
  • EN for English (limited support)
About Credits

An account can have a number of export credits. These should be consumed when importing data into the calling application. This is part of the license/agreement attached to the API key.

About Rate Limit

Every response contains headers with the limit, remaining calls and seconds until reset. These headers are: X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.

Because the response can be cached, the headers might not contain the current values. Use the /api1/ratelimit resource for the current values.

When the limit has been reached, the HTTP status code 429 (Too Many Request) will be returned. An extra header Retry-After will be added, containing the number of seconds until the counter is reset.

The default limit is currently set to 200 requests an hour per login.