Lookup Engine Reference¶
ISIN Lookup Table¶
tickertape.lookup.table.ISINLookupTable ¶
Persistent SQLite store mapping mutual fund ISINs to TickerTape records and categorization.
Source code in src/tickertape/lookup/table.py
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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | |
all ¶
Return all mappings in the database.
Source code in src/tickertape/lookup/table.py
clear ¶
count ¶
Return total number of indexed mappings in lookup table.
export_csv ¶
Export the full lookup table to a CSV file.
Source code in src/tickertape/lookup/table.py
export_json ¶
Export the full lookup table to a JSON file.
Source code in src/tickertape/lookup/table.py
find_funds ¶
find_funds(
*,
sector: Optional[str] = None,
subsector: Optional[str] = None,
fund_type: Optional[str] = None,
plan: Optional[str] = None,
option: Optional[str] = None,
risk_level: Optional[str] = None,
benchmark: Optional[str] = None,
amc: Optional[str] = None,
limit: int = 100
) -> list[ISINMapping]
Gather mutual funds sharing similar classification attributes (peers).
Useful for AI agents to compare funds in the same category or benchmark.
Source code in src/tickertape/lookup/table.py
get ¶
Fetch mapping for a specific ISIN.
Source code in src/tickertape/lookup/table.py
get_all_isins ¶
Return a set of all indexed ISINs.
get_all_record_ids ¶
Return a set of all indexed TickerTape record_ids.
Source code in src/tickertape/lookup/table.py
get_batch ¶
Fetch mappings for multiple ISINs at once.
Source code in src/tickertape/lookup/table.py
get_by_record_id ¶
Fetch mapping by TickerTape record_id (e.g. 'M_QUNG').
Source code in src/tickertape/lookup/table.py
get_peers ¶
get_peers(
isin: str,
match_plan: bool = True,
match_option: bool = True,
limit: int = 20,
) -> list[ISINMapping]
Get peer mutual funds in the same subsector/category as the given ISIN.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
isin
|
str
|
Source fund ISIN. |
required |
match_plan
|
bool
|
If True, matches plan (e.g. Direct with Direct). |
True
|
match_option
|
bool
|
If True, matches option (e.g. Growth with Growth). |
True
|
limit
|
int
|
Maximum peers to return. |
20
|
Source code in src/tickertape/lookup/table.py
upsert ¶
upsert_batch ¶
Insert or update multiple ISIN mappings in a single atomic transaction.
Source code in src/tickertape/lookup/table.py
Targeted ISIN Resolver¶
tickertape.lookup.resolver.ISINResolver ¶
Resolves specific ISINs on demand using local sitemap slug matching and verification.
Source code in src/tickertape/lookup/resolver.py
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 | |
resolve
async
¶
resolve(
isin: str,
hint_name: Optional[str] = None,
max_candidates: int = 3,
) -> Optional[ISINMapping]
Resolve an ISIN to a TickerTape mapping.
Checks the persistent SQLite table first. If not found, uses hint_name to search candidate slugs in the cached sitemap, verifies the page ISIN, and saves it to the SQLite lookup table upon match.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
isin
|
str
|
Mutual fund ISIN string (e.g. 'INF966L01721'). |
required |
hint_name
|
Optional[str]
|
Optional scheme name to narrow candidates. |
None
|
max_candidates
|
int
|
Maximum candidate pages to inspect. |
3
|
Returns:
| Type | Description |
|---|---|
Optional[ISINMapping]
|
ISINMapping if successfully resolved, otherwise None. |
Source code in src/tickertape/lookup/resolver.py
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 | |
Bulk ISIN Indexer¶
tickertape.lookup.indexer.ISINIndexer ¶
Crawls mutual fund pages from sitemap and populates SQLite ISIN lookup table.
Source code in src/tickertape/lookup/indexer.py
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 171 172 173 174 175 176 177 178 179 180 181 | |
build_index
async
¶
build_index(
*,
force_refresh: bool = False,
concurrency: int = 5,
delay: float = 0.5,
limit: Optional[int] = None,
progress_callback: Optional[ProgressCallback] = None
) -> int
Build or update the SQLite ISIN lookup table from the mutual funds sitemap.
Force Refresh Logic
When force_refresh=True: 1. Fetches live sitemap XML from TickerTape. 2. Parses sitemap and updates the local sitemap cache (.cache/tickertape/sitemaps/mf.json). 3. Crawls fund pages and updates the SQLite database (.cache/tickertape/isin_lookup.db).
When force_refresh=False: 1. Loads sitemap from local disk cache. 2. Skips record_ids already present in SQLite database (resumable). 3. Crawls only missing funds and inserts into SQLite database.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
force_refresh
|
bool
|
If True, forces live sitemap fetch, updates sitemap cache, and re-indexes. |
False
|
concurrency
|
int
|
Number of concurrent HTTP workers. |
5
|
delay
|
float
|
Delay in seconds between requests per worker to respect rate limits. |
0.5
|
limit
|
Optional[int]
|
Optional maximum number of funds to process (useful for testing or batch runs). |
None
|
progress_callback
|
Optional[ProgressCallback]
|
Optional callback(completed, total, successful, failed). |
None
|
Returns:
| Type | Description |
|---|---|
int
|
Number of mappings successfully indexed/updated in SQLite database. |
Source code in src/tickertape/lookup/indexer.py
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 171 172 173 174 175 176 177 178 179 180 181 | |
ISIN Mapping Model¶
tickertape.lookup.models.ISINMapping ¶
Bases: BaseModel
Mapping entry linking a mutual fund ISIN to TickerTape record and categorization metadata.
Contains stable classification and grouping attributes used by AI agents to cluster and identify similar/peer mutual funds.