{"id":22790387,"url":"https://github.com/sdclarkelab/jamstockex-api","last_synced_at":"2025-04-16T02:58:53.982Z","repository":{"id":42246182,"uuid":"270867097","full_name":"sdclarkelab/jamstockex-api","owner":"sdclarkelab","description":"Jamaica Stock Exchange (jamstockex/ JSE) API v2.","archived":false,"fork":false,"pushed_at":"2023-03-05T11:52:32.000Z","size":1254,"stargazers_count":9,"open_issues_count":9,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T04:31:43.753Z","etag":null,"topics":["api","express","heroku","jamaica","jamstockex","javascript","json","mongodb","mongoose","node","nodejs","rest-api","stockwatchja"],"latest_commit_sha":null,"homepage":"https://jamstockex-api.herokuapp.com/api/v2/stocks","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sdclarkelab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-09T00:47:32.000Z","updated_at":"2023-03-31T15:27:51.000Z","dependencies_parsed_at":"2023-02-18T06:55:16.766Z","dependency_job_id":null,"html_url":"https://github.com/sdclarkelab/jamstockex-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdclarkelab%2Fjamstockex-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdclarkelab%2Fjamstockex-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdclarkelab%2Fjamstockex-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdclarkelab%2Fjamstockex-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdclarkelab","download_url":"https://codeload.github.com/sdclarkelab/jamstockex-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249188256,"owners_count":21227011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","express","heroku","jamaica","jamstockex","javascript","json","mongodb","mongoose","node","nodejs","rest-api","stockwatchja"],"created_at":"2024-12-12T02:26:26.780Z","updated_at":"2025-04-16T02:58:53.965Z","avatar_url":"https://github.com/sdclarkelab.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StockWatchJa: JamStockEx API v2\nThe **StockWatchJa: JamStockEx API v2** serves up stock details info as JSON at this [URL](http://jamstockexapi.stockwatchja.com/stocks). The data is pulled from **[StockWatchJa: JamStockEx Scraper](https://github.com/sdclarkelab/jamstockex-scraper)**.\n\n#### Response Preview\n```javascript\n{\n  \"stocks\": [\n    {\n      \"id\": \"5f4efd8b77435e97079e95bb\",\n      \"lastUpdatedDate\": \"1995-06-22T18:31:18.362Z\",\n      \"instrumentName\": \"SOME STOCK NAME\",\n      \"symbol\": \"SYMBOL\",\n      \"currency\": \"JMD\",\n      \"sector\": \"TOURISM\",\n      \"type\": \"ORDINARY\",\n      \"website\": null,\n      \"isListed\": true,\n      \"market\": \"Main Market\",\n      \"corporateActionUrl\": \"https://www.jamstockex.com/market-data/listed-companies/corporate-actions/SYMBOL/latest\",\n      \"dividends\": [],\n      \"tradeInfo\": {\n        \"volumeTraded\": 955,\n        \"dollarChange\": 0,\n        \"marketPrice\": 0.3,\n        \"percentageChange\": 0,\n        \"lastUpdatedDate\": \"1995-06-22T18:31:18.345Z\"\n      }\n    },\n  .....\n  ],\n  \"results\": 10,\n  \"total\": 245,\n}\n```\n\n## API Documentation\nClick **[here](https://documenter.getpostman.com/view/6678518/TVt2biUM)** to view the API documentation.\n\n## Requirements  \nTool | Version  | Source |  \n--- | --- | --- |  \nNodeJs | **10.16.2** (includes npm 6.9.0) | [Nodejs v10.x Releases](https://nodejs.org/dist/latest-v10.x/) | \nHeroku|-|[Getting Started on Heroku with Python](https://devcenter.heroku.com/articles/getting-started-with-python)|\nWindows OS| 10 | - | \n\n\n## Heroku Setup\n\n### Installation\n1. Install GIT\n2. [Install Heroku](https://devcenter.heroku.com/articles/getting-started-with-python#set-up)\n3. Login using the following command\n```shell script\nheroku login\n```\n\n### Prepare Heroku to recieve source code\n\n#### Create environment file file\nCreate \".env\" in application root folder\n```.env\nDB=\"\u003cMongoDB-node-2.2.12-connection-string\u003e\"\nPORT=5000\n```\n\n#### Create Heroku project in Heroku\n```shell script\nheroku create jamstockex-api\n```\n\n### Set Environment Variables\n```shell script\nheroku config:set DB=\"\u003cMongoDB-node-2.2.12-connection-string\u003e\"\nheroku config:set PORT=5000\n```\n\n### Deploy \n```shell script\ngit push heroku your_local_branch_name:master\n```\nValidate that the application is live\n```shell script\nheroku ps:scale web=1\n```\n#### Test locally with heroku\n```shell script\nheroku local web\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdclarkelab%2Fjamstockex-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdclarkelab%2Fjamstockex-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdclarkelab%2Fjamstockex-api/lists"}