phisix

Simple PSEi (formerly known as PHISIX) RESTful API hosted on Google AppEngine

⚠️ IMPORTANT NOTICE: The public phisix-api.appspot.com service has been discontinued for legal reasons.
A takedown notice was received on November 30, 2023, and the service was shut down on December 4, 2023.
To access Philippine Stock Exchange data, please deploy your own instance using the instructions below.

Development & Deployment

Prerequisites

• Java 21 (OpenJDK recommended)
• Maven 3.6+
• Google Cloud SDK (for App Engine deployment)
• Git

Quick Start

1. Clone the repository

   git clone https://github.com/phisix-org/phisix.git
   cd phisix
   

2. Build the project

   mvn clean compile
   

3. Run tests

   mvn test
   

4. Run full verification (includes integration tests & code coverage)

   mvn clean verify
   

5. Run locally (for development)

   mvn clean package appengine:run
   

Local Development

Running with App Engine Development Server

Note: Always use mvn clean package appengine:run during development to ensure:

• Source code changes are recompiled
• Tests are executed
• Documentation changes are regenerated
• Site content is updated with latest modifications
• WAR file is properly packaged

1. Stage the application (optional - for testing staging process)

   mvn clean package appengine:stage
   

2. Run locally (recommended for development)

   mvn clean package appengine:run
   

   The API will be available at: http://localhost:8080

Test the local API

• All stocks (JSON): http://localhost:8080/stocks.json
• All stocks (XML): http://localhost:8080/stocks.xml
• Specific stock: http://localhost:8080/stocks/BDO.json
• Historical data: http://localhost:8080/stocks/BDO.2024-01-15.json

Deployment to Google App Engine

Prerequisites for Deployment

1. Setup Google Cloud Project

   gcloud projects create your-project-id
   gcloud config set project your-project-id
   gcloud app create
   

2. Enable App Engine API

   gcloud services enable appengine.googleapis.com
   

3. Authenticate

   gcloud auth login
   gcloud auth application-default login
   

Deploy to App Engine

1. Update pom.xml - Change the App Engine application name:

   <properties>
       <appengine.app.name>your-project-id</appengine.app.name>
   </properties>
   

2. Deploy

   mvn clean package appengine:deploy
   

   Your API will be available at: https://your-project-id.appspot.com

Project Structure

phisix/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/googlecode/phisix/api/
│   │   │       ├── client/          # PSE website scraping clients
│   │   │       ├── ext/             # JAX-RS providers & filters  
│   │   │       ├── parser/          # HTML & JSON parsers
│   │   │       ├── repository/      # Data access layer
│   │   │       └── resource/        # REST API endpoints
│   │   ├── resources/               # Configuration files
│   │   └── webapp/
│   │       ├── WEB-INF/            # Web app configuration
│   │       └── schema/             # XSD schemas
│   └── test/                       # Unit & integration tests
├── target/                         # Build output
├── pom.xml                        # Maven configuration
└── README.md                      # This file

Technology Stack

• Runtime: Java 21 (Jakarta EE 10)
• Framework: JAX-RS (RESTEasy 7.0.0.Final)
• Platform: Google App Engine Standard (Java 21)
• Build Tool: Maven
• Data Binding: JAXB (XML), Gson 2.13.2 (JSON)
• Web Scraping: JSoup
• Testing: JUnit, Mockito

API Endpoints

Once running, the following endpoints will be available:

Resources Summary

Stocks: look up stocks

GET http://phisix-api.appspot.com/stocks.{json|xml}
GET http://phisix-api.appspot.com/stocks/{symbol}.{json|xml}
GET http://phisix-api.appspot.com/stocks/{symbol}.{yyyy-MM-dd}.{json|xml}

JSON feeds

XML feeds

XSD

http://phisix-api.appspot.com/schema/stocks/phisix-stocks.xsd