Retrieve info related to dividend stocks.
You might also be interested in:
stock-bot
- Docker
- Node.js (only tested against
v14) - Yarn
To get started, run: docker-compose up, which will start a Redis instance and Fastify + GraphQL server.
To retrieve a dividend, you must first acquire an instrument to query against.
All requests must be authenticated
Request
curl --location --request POST 'http://localhost:3000/graphql' \
--header 'x-api-key: [YOUR API KEY]' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "query { fetchInstrumentWithIsin(isin: \"US5949181045\") { id } }"
}'
Response
{
"data": {
"fetchInstrumentWithIsin": {
"id": "17ae97b6-94cc-5543-b671-b862b1a6d5b7"
}
}
}
Request
curl --location --request POST 'http://localhost:3000/graphql' \
--header 'x-api-key: [YOUR API KEY]' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "query { fetchInstrumentWithSymbol(symbol: \"MSFT\") { id } }"
}'
Response
{
"data": {
"fetchInstrumentWithSymbol": {
"id": "17ae97b6-94cc-5543-b671-b862b1a6d5b7"
}
}
}
Now that you have an instrument, you can use this to retrieve a dividend
Request
curl --location --request POST 'http://localhost:3000/graphql' \
--header 'x-api-key: c7dd7869-d701-4259-8d36-18dd295ebb49' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "query { fetchDividend(id: \"17ae97b6-94cc-5543-b671-b862b1a6d5b7\"){ dividendYield } }"
}'
Response
{
"data": {
"fetchDividend": {
"dividendYield": 0.009189
}
}
}
An API key is used as an anonymous way to rate limit the service.
In order to generate API keys, you must set a value in the config under the server.authKey property.
Once this value is set, API keys can be generated using the following request:
curl --location --request POST 'http://localhost:3000/api/key-store' \
--header 'Content-Type: application/json' \
--data-raw '{
"authKey": "[YOUR server.authKey VALUE]"
}'
Response
{
"created": "2021-02-25T11:01:52.189Z",
"isBanned": false,
"key": "47ccf4d9-1ff8-453a-8286-5a96d7f842c3",
"lastUsed": "2021-02-25T11:01:52.189Z"
}
If a consumer makes more requests than the server.apiLimit.maxRequestsPerMinute value in the config (default: 300), they will receive a HTTP 429 response.
If the consumer continues to make requests whilst limited, and exceeds the server.apiLimit.banAfterMaxHttp429Responses value in the config (default: 30), the API key will be banned and the response code will be HTTP 409.
Run yarn test:integration from the Fastify container to test the suppliers are working as expected.
- Break dividend cache
- Config option to allow supplier preference for stock yield
- Add dividend payout ratio
- Add dividend next payment date
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent