keys
In order for TWASE to provide an API service for developers, we need to ensure that our server infrastructure is able to handle the demand of inbound client API calls plus the myriad of backend processing resulting from each method request.
By requiring developers to use an API Key, we are able to gain visibility on the range and number of inbound API calls to our platform per minute and to enable a throttle mechanism to ensure that a fair service can be provided to all our users.
format
The Key is a 32 character string that is generated when you initially request it and is unique to all other Keys in our system. Please do not share your Key with anyone and only use it within applications or projects that you work on.
constraints
You can only have one Key per email address, so if you need more than a single Key, but do not want to use another email address, please Contact us and we'll hook you up on a case-by-case basis.
When making an API call, you will need to send your Key over to our server as part of the call URL. The API server uses SSL and so as part of the HTTPS Get request, your Key will be encrypted as part of transaction (and thus can not be 'sniffed' between your client and our server).
request a key
To start working with the API, you'll need an API Key:
- request an API Key - Generate Key
- check your email - the Key is generated and emailed immediately
- test your Key in a browser - an example will be emailed to you