{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "59d19f73",
   "metadata": {},
   "source": [
    "# Python API Example - Cargo Arb Breakevens\n",
    "\n",
    "This guide is designed to provide an example of how to call the Arb Breakevens API endpoint, and store the data accordingly.\n",
    "\n",
    "__N.B. This guide is just for Arb Breakevens data. If you're looking for other API data products (such as Netbacks, Price releases or Freight routes), please refer to their according code example files.__ "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b0a05be4",
   "metadata": {},
   "source": [
    "### Have any questions?\n",
    "\n",
    "If you have any questions regarding our API, or need help accessing specific datasets, please contact us at:\n",
    "\n",
    "__data@sparkcommodities.com__"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9e00ae34",
   "metadata": {},
   "source": [
    "## 1. Importing Data\n",
    "\n",
    "Here we define the functions that allow us to retrieve the valid credentials to access the Spark API.\n",
    "\n",
    "__This section can remain unchanged for most Spark API users.__"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "16099f90",
   "metadata": {},
   "outputs": [],
   "source": [
    "import json\n",
    "import os\n",
    "import sys\n",
    "import pandas as pd\n",
    "import numpy as np\n",
    "from base64 import b64encode\n",
    "from urllib.parse import urljoin\n",
    "from io import StringIO\n",
    "import datetime\n",
    "\n",
    "try:\n",
    "    from urllib import request, parse\n",
    "    from urllib.error import HTTPError\n",
    "except ImportError:\n",
    "    raise RuntimeError(\"Python 3 required\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "1161e807",
   "metadata": {},
   "outputs": [],
   "source": [
    "API_BASE_URL = \"https://api.sparkcommodities.com\"\n",
    "\n",
    "\n",
    "def retrieve_credentials(file_path=None):\n",
    "    \"\"\"\n",
    "    Find credentials either by reading the client_credentials file or reading\n",
    "    environment variables\n",
    "    \"\"\"\n",
    "    if file_path is None:\n",
    "        client_id = os.getenv(\"SPARK_CLIENT_ID\")\n",
    "        client_secret = os.getenv(\"SPARK_CLIENT_SECRET\")\n",
    "        if not client_id or not client_secret:\n",
    "            raise RuntimeError(\n",
    "                \"SPARK_CLIENT_ID and SPARK_CLIENT_SECRET environment vars required\"\n",
    "            )\n",
    "    else:\n",
    "        # Parse the file\n",
    "        if not os.path.isfile(file_path):\n",
    "            raise RuntimeError(\"The file {} doesn't exist\".format(file_path))\n",
    "\n",
    "        with open(file_path) as fp:\n",
    "            lines = [l.replace(\"\\n\", \"\") for l in fp.readlines()]\n",
    "\n",
    "        if lines[0] in (\"clientId,clientSecret\", \"client_id,client_secret\"):\n",
    "            client_id, client_secret = lines[1].split(\",\")\n",
    "        else:\n",
    "            print(\"First line read: '{}'\".format(lines[0]))\n",
    "            raise RuntimeError(\n",
    "                \"The specified file {} doesn't look like to be a Spark API client \"\n",
    "                \"credentials file\".format(file_path)\n",
    "            )\n",
    "\n",
    "    print(\">>>> Found credentials!\")\n",
    "    \n",
    "    return client_id, client_secret\n",
    "\n",
    "\n",
    "def do_api_post_query(uri, body, headers):\n",
    "    \"\"\"\n",
    "    OAuth2 authentication requires a POST request with client credentials before accessing the API.\n",
    "    This POST request will return an Access Token which will be used for the API GET request.\n",
    "    \"\"\"\n",
    "    url = urljoin(API_BASE_URL, uri)\n",
    "\n",
    "    data = json.dumps(body).encode(\"utf-8\")\n",
    "\n",
    "    # HTTP POST request\n",
    "    req = request.Request(url, data=data, headers=headers)\n",
    "    try:\n",
    "        response = request.urlopen(req)\n",
    "    except HTTPError as e:\n",
    "        print(\"HTTP Error: \", e.code)\n",
    "        print(e.read())\n",
    "        sys.exit(1)\n",
    "\n",
    "    resp_content = response.read()\n",
    "\n",
    "    # The server must return HTTP 201. Raise an error if this is not the case\n",
    "    assert response.status == 201, resp_content\n",
    "\n",
    "    # The server returned a JSON response\n",
    "    content = json.loads(resp_content)\n",
    "\n",
    "    return content\n",
    "\n",
    "\n",
    "def do_api_get_query(uri, access_token, format='json'):\n",
    "    \"\"\"\n",
    "    After receiving an Access Token, we can request information from the API.\n",
    "    Supports both JSON (default) and CSV responses.\n",
    "    \"\"\"\n",
    "    url = urljoin(API_BASE_URL, uri)\n",
    "\n",
    "    if format == 'json':\n",
    "        headers = {\n",
    "            \"Authorization\": \"Bearer {}\".format(access_token),\n",
    "            \"Accept\": \"application/json\",\n",
    "        }\n",
    "    elif format == 'csv':\n",
    "        headers = {\n",
    "            \"Authorization\": \"Bearer {}\".format(access_token),\n",
    "            \"Accept\": \"text/csv\",\n",
    "        }\n",
    "    else:\n",
    "        raise ValueError(\"The format parameter only takes 'csv' or 'json' as inputs\")\n",
    "\n",
    "    print(\"Fetching {}\".format(url))\n",
    "\n",
    "    # HTTP GET request\n",
    "    req = request.Request(url, headers=headers)\n",
    "    try:\n",
    "        response = request.urlopen(req)\n",
    "    except HTTPError as e:\n",
    "        print(\"HTTP Error: \", e.code)\n",
    "        print(e.read())\n",
    "        sys.exit(1)\n",
    "\n",
    "    resp_content = response.read()\n",
    "\n",
    "    # The server must return HTTP 200. Raise an error if this is not the case\n",
    "    assert response.status == 200, resp_content\n",
    "\n",
    "    # Storing response based on requested format\n",
    "    if format == 'json':\n",
    "        content = json.loads(resp_content)\n",
    "    elif format == 'csv':\n",
    "        content = resp_content\n",
    "\n",
    "    return content\n",
    "\n",
    "\n",
    "def get_access_token(client_id, client_secret):\n",
    "\n",
    "    payload = \"{}:{}\".format(client_id, client_secret).encode()\n",
    "    headers = {\n",
    "        \"Authorization\": b64encode(payload).decode(),\n",
    "        \"Accept\": \"application/json\",\n",
    "        \"Content-Type\": \"application/json\",\n",
    "    }\n",
    "    body = {\n",
    "        \"grantType\": \"clientCredentials\",\n",
    "    }\n",
    "\n",
    "    content = do_api_post_query(uri=\"/oauth/token/\", body=body, headers=headers)\n",
    "\n",
    "    print(\n",
    "        \">>>> Successfully fetched an access token {}****, valid {} seconds.\".format(\n",
    "            content[\"accessToken\"][:5], content[\"expiresIn\"]\n",
    "        )\n",
    "    )\n",
    "\n",
    "    return content[\"accessToken\"]"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1e890e9e",
   "metadata": {},
   "source": [
    "## N.B. Credentials\n",
    "\n",
    "Here we call the above functions, and input the file path to our credentials.\n",
    "\n",
    "N.B. You must have downloaded your client credentials CSV file before proceeding. Please refer to the API documentation if you have not dowloaded them already.  Instructions for downloading your credentials can be found here:\n",
    "\n",
    "https://www.sparkcommodities.com/api/request/authentication.html\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "2b010f83",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Input the path to your client credentials here\n",
    "client_id, client_secret = retrieve_credentials(file_path=\"/tmp/client_credentials.csv\")\n",
    "\n",
    "# Authenticate:\n",
    "access_token = get_access_token(client_id, client_secret)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "cebe46ba",
   "metadata": {},
   "source": [
    "## Netbacks Reference Data\n",
    "\n",
    "Calling the netbacks reference data endpoint to retrieve available FOB Ports and their corresponding UUIDs"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d0b35b50",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Define the function for listing all netback reference data\n",
    "def list_netbacks(access_token):\n",
    "\n",
    "    content = do_api_get_query(\n",
    "        uri=\"/v1.0/netbacks/reference-data/\", access_token=access_token\n",
    "    )\n",
    "\n",
    "    # retrieve release dates separately\n",
    "    reldates = content[\"data\"][\"staticData\"][\"sparkReleases\"]\n",
    "\n",
    "    # return reference data\n",
    "    refdata_dict = content[\"data\"]\n",
    "\n",
    "    return reldates, refdata_dict\n",
    "\n",
    "# Fetch reference data:\n",
    "reldates, refdata_dict = list_netbacks(access_token)\n",
    "\n",
    "# formatting as a Dataframe\n",
    "available_df = pd.json_normalize(refdata_dict['staticData']['fobPorts'])\n",
    "available_df.head(3)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "47f07d4d",
   "metadata": {},
   "source": [
    "## Defining Function to Fetch Arb Breakevens data\n",
    "\n",
    "The endpoint is divided into 2 sub-endpoints: \"/freight\" and \"/jkm-ttf\". Here, the function treats the breakeven type as an input to choose the required sub-endpoint\n",
    "\n",
    "More information on parameters for this endpoint can be found on the API Website:\n",
    "\n",
    "https://www.sparkcommodities.com/api/lng-cargo/netbacks-arb-breakevens.html"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "eb563eb4",
   "metadata": {},
   "outputs": [],
   "source": [
    "\n",
    "\n",
    "def fetch_breakevens(access_token, fob_port_uuid, via_point=None, breakeven='jkm-ttf', start=None, end=None, format='json'):\n",
    "    \n",
    "    #For a route, fetch then display the route details\n",
    "    #https://api.sparkcommodities.com/v1.0/netbacks/arb-breakevens/\n",
    "    \n",
    "\n",
    "\n",
    "    query_params = breakeven + '/' + \"?fob-port={}\".format(fob_port_uuid)\n",
    "\n",
    "    if via_point is not None:\n",
    "        query_params += \"&via-point={}\".format(via_point)\n",
    "    if start is not None:\n",
    "        query_params += \"&start={}\".format(start)\n",
    "    if end is not None:\n",
    "        query_params += \"&end={}\".format(end)\n",
    "\n",
    "    uri = \"/v1.0/netbacks/arb-breakevens/{}\".format(query_params)\n",
    "    print(uri)\n",
    "    content = do_api_get_query(\n",
    "        uri=\"/v1.0/netbacks/arb-breakevens/{}\".format(query_params),\n",
    "        access_token=access_token, format=format,\n",
    "    )\n",
    "    \n",
    "    if format == 'json':\n",
    "        my_dict = content['data']\n",
    "    else:\n",
    "        my_dict = content.decode('utf-8')\n",
    "        my_dict = pd.read_csv(StringIO(my_dict))\n",
    "\n",
    "    return my_dict\n",
    "\n",
    "\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7f54f047",
   "metadata": {},
   "source": [
    "### Choosing FOB Port"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "09e6ca7b",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Select Route\n",
    "tsab = available_df[available_df[\"name\"] == 'Sabine Pass'][\"uuid\"].iloc[0]"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8077480d",
   "metadata": {},
   "source": [
    "### JSON Response Example"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3c9e519c",
   "metadata": {},
   "outputs": [],
   "source": [
    "## Calling that function and storing the output - JSON version\n",
    "json_data = fetch_breakevens(access_token, fob_port_uuid=tsab, via_point='cogh', breakeven='jkm-ttf', start='2025-07-20', end='2025-07-30')\n",
    "json_data"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ff498957",
   "metadata": {},
   "source": [
    "## CSV example"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "30d317eb",
   "metadata": {},
   "outputs": [],
   "source": [
    "# calling the same data in CSV format. This option automatically converts the data to a pandas dataframe.\n",
    "csv_df = fetch_breakevens(access_token, fob_port_uuid=tsab, via_point='cogh', breakeven='jkm-ttf', start='2025-07-20', end='2025-07-30', format='csv')\n",
    "csv_df"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "base",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.13.9"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}