fathomnet-py
fathomnet-py is a client-side API to help scientists, researchers, and developers interact with FathomNet Database data.
>>> from fathomnet.api import boundingboxes
>>> boundingboxes.find_concepts()
['2G Robotics structured light laser', '55-gallon drum', ...]
>>> from fathomnet.api import images
>>> images.find_by_concept('Nanomia')
[
AImageDTO(
id=2274942,
uuid='cdbfca66-284f-48ac-a36f-7b2ac2b43533',
url='https://database.fathomnet.org/static/m3/framegrabs/MiniROV/images/0056/02_18_37_20.png',
...
),
...
]
>>> from fathomnet.api import taxa
>>> taxa.find_children('fathomnet', 'Bathochordaeus')
[
Taxa(name='Bathochordaeus stygius', rank='species'),
Taxa(name='Bathochordaeus charon', rank='species'),
Taxa(name='Bathochordaeus mcnutti', rank='species')
]
>>> from fathomnet.api import xapikey
>>> xapikey.auth('NuCLjlNUlgHchtgDB01Sp1fABJVcWR') # your API key here
AuthHeader(
type='Bearer',
token='eyJhbGciOiJI...'
)
The fathomnet-py API offers native Python interaction with the FathomNet REST API, abstracting away the underlying HTTP requests.
Installing fathomnet-py
fathomnet-py is available on PyPI:
$ python -m pip install fathomnet
Examples
API Tutorial: 
FathomNet Models:
API Reference available on Read the Docs
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fathomnet-1.10.0.tar.gz
(171.4 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fathomnet-1.10.0.tar.gz.
File metadata
- Download URL: fathomnet-1.10.0.tar.gz
- Upload date:
- Size: 171.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.10.1 {"installer":{"name":"uv","version":"0.10.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e7c4de5b3ae92c55dbaf06df1f82e3a5a7bfab2ce3b80ce76efe9787377005c
|
|
| MD5 |
230ade447087f70a297ff32155efa8fd
|
|
| BLAKE2b-256 |
4a696a762e8f74a5c16266f903497a42eb4b5eec728f2fe48814fd54fa8001ea
|
File details
Details for the file fathomnet-1.10.0-py3-none-any.whl.
File metadata
- Download URL: fathomnet-1.10.0-py3-none-any.whl
- Upload date:
- Size: 29.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.10.1 {"installer":{"name":"uv","version":"0.10.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b17b56dfe044186c2f5d18ca980c61af0d7eb43deb0939594084b8542307b37
|
|
| MD5 |
01cc2efbb78a8c8b295c484d46aaeb94
|
|
| BLAKE2b-256 |
c1c827282d2f13dbb051250e2dde9996980176a7ede8ee5a2ee57352e8b44913
|
