aboutsummarylogtreecommitdiffstats
path: root/api.h
blob: cd1b4be60431d8c177ebac7f39ae2147870a9b78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/**
 * API data is taken from IEX Trading, Morningstar, Coinmarketcap, and News API.
 * https://iextrading.com/developer/docs/
 * http://www.morningstar.com/
 * https://coinmarketcap.com/api/
 * https://newsapi.org/docs
 */

#ifndef API_H
#define API_H

#define EMPTY (-999)

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stddef.h>
#include <curl/curl.h>
#include <json-c/json_tokener.h>

struct string {
    char* data;
    size_t len;
};

typedef struct string String;

struct info {
    char* name; // Name of security (ex. Apple Inc.)
    char* symbol; // Symbol of security (ex. AAPL)
    double price; // Current price of security in USD (ex. 174.54)
    double change_1d, change_7d, change_30d; // Percent change in the past x days (ex. -7.49)
    double div_yield; // Percent dividend yield (ex. 1.46)
    long marketcap; // Market cap in USD (ex. 890489000000)
    long volume_1d; // Volume in shares of security (ex. 33812360)
};

typedef struct info Info;

typedef struct json_object Json;

/**
 * Creates and returns a STRING
 * object with size 1 and no data
 * @return STRING object
 */
String* api_string_init(void);

/**
 * Creates and returns an Info object
 * @return Info object
 */
Info* api_info_init(void);

/**
 * GETs data from API server and returns it in a String
 * @param url API url to GET
 * @param post_field data needed for POST
 * @return NULL if no response from server. Otherwise, String containing data.
 */
String* api_curl_data(char* url, char* post_field);

/**
 * Returns a double* containing the current price and yesterday's price of a stock or cryptocurrency.
 * [0] = current intraday price
 * [1] = last close price
 * Order:
 * 1. IEX -- NASDAQ/NYSE/NYSEARCA
 * 2. Morningstar -- MUTF/OTCMKTS
 * 3. Coinmarketcap -- CRYPTO
 * @param ticker_name_string symbol
 * @return price data or NULL if invalid symbol
 */
double* api_get_current_price(const char* ticker_name_string);

/**
 * writefunction for cURL HTTP GET
 * stolen from a nice man on stackoverflow
 */
size_t api_string_writefunc(void* ptr, size_t size, size_t nmemb, String* hString);

/**
 * Returns current and yesterday's price of a stock with data from IEX.
 * Tested for NASDAQ, NYSE, and NYSEARCA listed stocks/ETFs.
 * @param ticker_name_string symbol
 * @return price data as defined by api_get_current_price or NULL if invalid symbol
 */
double* iex_get_price(const char* ticker_name_string);

/**
 * Returns current and yesterday's price of a mutual fund with data from Morningstar
 * Tested for MUTF and OTCMKTS listed securities.
 * @param ticker_name_string symbol
 * @param offset number of days ago to get price of (0 = today)
 * @return price data as defined by api_get_current_price or NULL if invalid symbol
 */
double* morningstar_get_price(const char* ticker_name_string);

/**
 * Returns current and yesterday's price of a cryptocurrency with data from Coinmarketcap.
 * All cryptocurrencies listed on Coinmarketcap will work.
 * @param ticker_name_string symbol
 * @return price data as defined by api_get_current_price or NULL if invalid symbol
 */
double* coinmarketcap_get_price(const char* ticker_name_string);

/**
 * Prints top three news articles in the past week based on the given string
 * @param ticker_name_string the string
 */
void news_print_top_three(const char* ticker_name_string);

/**
 * Given a JSON formatted string, print title, source, author, and url of articles
 * @param data the json formatted data
 */
void json_print_news(Json* jobj);

/**
 * Prints info about the given symbol
 * @param ticker_name_string the symbol
 */
void api_print_info(const char* ticker_name_string);

/**
 * Returns a pointer to an Info object containing info pertaining
 * to the given symbol
 * @param ticker_name_string stock/etf symbol
 * @return Info object
 */
Info* iex_get_info(const char* ticker_name_string);

Info* morningstar_get_info(const char* ticker_name_string);

/**
 * Returns a pointer to an Info object containing info pertaining
 * to the given crypto
 * @param ticker_name_string the crypto's name
 * @return Info object
 */
Info* coinmarketcap_get_info(const char* ticker_name_string);

/**
 * Given a url, returns a shorter link using goo.gl
 * @param url_string the link to shorten
 * @return the shortened link
 */
char* google_shorten_link(const char* url_string);

/**
 * Returns a string stripped of the given char
 * @param string the string to strip the char from
 * @param c the char to strip
 * @return the stripped string
 */
char* strip_char(const char* string, char c);

/**
 * Destroys String object and frees memory
 * @param phString the String to destroy
 */
void api_string_destroy(String** phString);

/**
 * Destroys Info object and frees memory
 * @param phInfo the Info to destroy
 */
void api_info_destroy(Info** phString);

#endif