VoiceAttack
General => How Do I? => Topic started by: electricscout on March 31, 2025, 02:05:12 PM
-
I'm very, very inexperienced with stuff like this so bear with me.
I'm trying to make a command that will run a c# script with the intention of using UEXCorps API to get the price of a specific commodity, however I've tried a few different things but really dont know where to start with this. Does anybody know how/if i can send an API get request with a VA c# script?
-
You can absolutely do this. I use inline functions in C# to contact the OpenWeatherMap API in my AVCS SENSE profile dealing with sensors & weather.
You should be able to refer to the API documentation from UEXCorps (assuming they have good documentation) on how to contact their API to get the info you need. A good API presents syntax and code examples, hopefully in more than one language (including C#).
If you're super new to C#, you can get a quick leg up with the basics presented by W3 Schools here:
https://www.w3schools.com/cs (https://www.w3schools.com/cs/index.php)
-
Thank you! The documentation for UEX's api seems somewhat mediocre since it only has the url for the data you want to access and what it should return, nothing on how I actually go about sending a request to it in the first place.
-
Thank you! The documentation for UEX's api seems somewhat mediocre since it only has the url for the data you want to access and what it should return, nothing on how I actually go about sending a request to it in the first place.
Not all API's are equal, and so it may require a bit more knowledge or effort on the part of users. For example, on the OpenWeatherMap API, we must apply for an API key and then we must use that key in each URL request from the API in order to receive results - it is documented like this:
(https://i.imgur.com/uf42oic.png)
...now, the UEX API does have many pages dictating how to make calls to their API, and note that a Bearer Token is required yet does not provide any examples of where this belongs in the API request URL:
(https://i.imgur.com/zWPZbRQ.png)
(and for the commodities prices, an actual call - shows no place to insert the Bearer Token - and I tried in various ways just for a test, came up empty)
(https://i.imgur.com/OK1ErWH.png)
The only thing I can think of is to contact them (or someone who already uses this API), or find an example of a working API application for UEX and see how they do things. Wish I could help more, but their documentation seems to be lacking imho.
For example, when I need to get data from OpenWeatherMaps API, I assemble the URL with the request I need and including my API key as documented, and use this method in a C# inline function within a VoiceAttack command:
using System.Net;
private void GetWeatherApiReturn(string apiURL, dynamic VA)
{
VA.SetText("~api_return", null);
string apiReturn = string.Empty;
try
{
using (WebClient wc = new WebClient())
{
wc.Headers.Add("Accept-Language", " en-US");
wc.Headers.Add("Accept", " text/html, application/xhtml+xml, */*");
apiReturn = wc.DownloadString(apiURL);
}
}
catch (WebException ex)
{
VA.WriteToLog("API ERROR!", "red");
if (ex.Status == WebExceptionStatus.ProtocolError && ex.Response != null)
{
var resp = (HttpWebResponse)ex.Response;
if (resp.StatusCode == HttpStatusCode.NotFound)// handle HTTP 404 errors
{
VA.WriteToLog("HTTP 404 - Unable to find page at URL:", "red");
VA.WriteToLog(apiURL, "blank");
}
}
}
finally
{
VA.SetText("~api_return", apiReturn);
}
}
-
Thank you so much. Thats so helpful, even if the documentation is less so. I really appreciate your own example and I'm sure it'll come in handy.
-
I thought I'd update saying that I got it to work! The code isn't very pretty or anything but I'll leave it here in case anyone tries to do a similar thing in the future.
using System;
using System.Net;
using System.Collections.Generic;
using Newtonsoft.Json;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
public class DataItem
{
public int id { get; set; }
public int id_commodity { get; set; }
public int id_star_system { get; set; }
public int id_planet { get; set; }
public int id_orbit { get; set; }
public int id_moon { get; set; }
public int id_city { get; set; }
public int id_outpost { get; set; }
public int id_poi { get; set; }
public int id_faction { get; set; }
public int id_terminal { get; set; }
// Buy prices
public float price_buy { get; set; }
public float price_buy_min { get; set; }
public float price_buy_min_week { get; set; }
public float price_buy_min_month { get; set; }
public float price_buy_max { get; set; }
public float price_buy_max_week { get; set; }
public float price_buy_max_month { get; set; }
public float price_buy_avg { get; set; }
public float price_buy_avg_week { get; set; }
public float price_buy_avg_month { get; set; }
public float price_buy_users { get; set; }
public int price_buy_users_rows { get; set; }
// Sell prices
public float price_sell { get; set; }
public float price_sell_min { get; set; }
public float price_sell_min_week { get; set; }
public float price_sell_min_month { get; set; }
public float price_sell_max { get; set; }
public float price_sell_max_week { get; set; }
public float price_sell_max_month { get; set; }
public float price_sell_avg { get; set; }
public float price_sell_avg_week { get; set; }
public float price_sell_avg_month { get; set; }
public float price_sell_users { get; set; }
public int? price_sell_users_rows { get; set; }
// SCU buy
public float scu_buy { get; set; }
public float scu_buy_min { get; set; }
public float scu_buy_min_week { get; set; }
public float scu_buy_min_month { get; set; }
public float scu_buy_max { get; set; }
public float scu_buy_max_week { get; set; }
public float scu_buy_max_month { get; set; }
public float scu_buy_avg { get; set; }
public float scu_buy_avg_week { get; set; }
public float scu_buy_avg_month { get; set; }
public float scu_buy_users { get; set; }
public int? scu_buy_users_rows { get; set; }
// Reported inventory SCU at location (sell)
public float scu_sell_stock { get; set; }
public float scu_sell_stock_avg { get; set; }
public float scu_sell_stock_avg_week { get; set; }
public float scu_sell_stock_avg_month { get; set; }
// SCU sell demand (forecasted)
public float scu_sell { get; set; }
public float scu_sell_min { get; set; }
public float scu_sell_min_week { get; set; }
public float scu_sell_min_month { get; set; }
public float scu_sell_max { get; set; }
public float scu_sell_max_week { get; set; }
public float scu_sell_max_month { get; set; }
public float scu_sell_avg { get; set; }
public float scu_sell_avg_week { get; set; }
public float scu_sell_avg_month { get; set; }
public float scu_sell_users { get; set; }
public int scu_sell_users_rows { get; set; }
// Inventory state for purchase
public int status_buy { get; set; }
public int status_buy_min { get; set; }
public int status_buy_min_week { get; set; }
public int status_buy_min_month { get; set; }
public int status_buy_max { get; set; }
public int status_buy_max_week { get; set; }
public int status_buy_max_month { get; set; }
public int status_buy_avg { get; set; }
public int status_buy_avg_week { get; set; }
public int status_buy_avg_month { get; set; }
// Inventory state for sell
public int status_sell { get; set; }
public int status_sell_min { get; set; }
public int status_sell_min_week { get; set; }
public int status_sell_min_month { get; set; }
public int status_sell_max { get; set; }
public int status_sell_max_week { get; set; }
public int status_sell_max_month { get; set; }
public int status_sell_avg { get; set; }
public int status_sell_avg_week { get; set; }
public int status_sell_avg_month { get; set; }
// Price coefficient of variation
public float volatility_price_buy { get; set; }
public float volatility_price_sell { get; set; }
public float volatility_scu_buy { get; set; }
public float volatility_scu_sell { get; set; }
// Factions
public int? faction_affinity { get; set; }
// Container
public string container_sizes { get; set; }
// Miscellaneous
public string game_version { get; set; }
public int date_added { get; set; }
public int date_modified { get; set; }
public string commodity_name { get; set; }
public string commodity_code { get; set; }
public string commodity_slug { get; set; }
public string star_system_name { get; set; }
public string planet_name { get; set; }
public string orbit_name { get; set; }
public string moon_name { get; set; }
public string space_station_name { get; set; }
public string outpost_name { get; set; }
public string city_name { get; set; }
public string terminal_name { get; set; }
public string terminal_code { get; set; }
public string terminal_slug { get; set; }
public int terminal_is_player_owned { get; set; }
}
public class ApiResponse
{
public string Status { get; set; }
public int HttpCode { get; set; }
public List<DataItem> Data { get; set; }
}
public class VAInline
{
public void main()
{
string apiReturn = string.Empty;
using (WebClient wc = new WebClient())
{
apiReturn = wc.DownloadString("https://api.uexcorp.space/2.0/commodities_prices?commodity_name=" + VA.GetText("~commodity"));
ApiResponse response = JsonConvert.DeserializeObject<ApiResponse>(apiReturn);
List<DataItem> dataList = response.Data;
float Lowest_Price = float.MaxValue;
string Lowest_Price_Terminal = dataList[0].terminal_name;
bool first = true;
foreach (var item in dataList)
{
if (item.price_buy_min < Lowest_Price && item.price_buy_min != 0)
{
Lowest_Price = item.price_buy_min;
Lowest_Price_Terminal = item.terminal_name;
}
}
VA.WriteToLog(Lowest_Price.ToString(), "black");
VA.SetText("~terminal", Lowest_Price_Terminal);
VA.SetDecimal("~price", (decimal)Lowest_Price);
}
//This is where your code goes. Note that the class and this function (main()) are required for this to work.
//You also have access to the shared VoiceAttack proxy object VA, which is the same that you will find
//used with the VoiceAttack plugin framework. See the help documentation for more info.
//VA.ExecuteCommand("myCommand");
//VA.ParseTokens("The time is {TIME}");
//VA.GetText("myTextVariable");
//VA.SetDecimal("myDecimalVariable", 2.2m);
//you get the idea;)
}
}