Skip to content

c00rni/Swiss-financial-events

Repository files navigation

Unofficial swiss CFA society API

Unffocial API for CFA society events in Swizterland. A helpful API for any developer who wants to develop application around CFA society events in Swizterland.

Navigate to the app website to create a free API key. The API can be test through the SwaggerHub documentation.

Usage

Login to the webapp to generate an API Key and request the API. Accounts are limited to 100 API calls per month.

curl -X 'GET' \
  'https://swiss-cfa-api-530073081731.europe-west6.run.app/api/v1/categories' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API_KEY>'

See the documentation to learn more about the API.

Install locally

Docker

The API use oauth2 to manage authentifiaction. Create a project and ID client Oauth on Google Platfome and run the commands below.

The Go server use libsql driver to connect to the Database. You can create a database on Turso and get and migrate the database schema by executing ./_scripts/migrateup.sh from the root.

docker pull corni/cfasociety:latest
docker run --rm -it -e GCP_CLIENT_ID=<YOUR_PROJECT_ID> -e GCP_CLIENT_SECRET=<YOUR_KEY> -e PORT=8080 -e DATABASE_URL=<YOUR_DATABASE_LINK> -e OAUTH_CALLBACK_URI=<YOUR_OAUTH_CALLBACK_URI> -p 8080:8080 corni/cfasociety:latest

🤝 Contributing

If you'd like to contribute, please fork the repository and open a pull request to the main branch.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published