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
Metadata
1 maintainer
Release files for fathomnet 1.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fathomnet-1.10.1.tar.gz | 172.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fathomnet-1.10.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 202.2 kB
Release files / fathomnet-1.10.1.tar.gz
| Download URL | fathomnet-1.10.1.tar.gz |
|---|---|
| Size | 172.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe740aa7a788ed81f796fa20cdf0a28f25fc3e7e52bcac2ccfb70d82bad7d623
|
|
BLAKE2b-256 checksum How to use checksums |
e8940751cfb29f71353bd1f61252eb0ec200bc5888d00422ea619503792c95e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","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}
|
Release files / fathomnet-1.10.1-py3-none-any.whl
| Download URL | fathomnet-1.10.1-py3-none-any.whl |
|---|---|
| Size | 30.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
762b25bbf99b450ce46cd032b84e67e56250d57dd7256ea21b55cc597350ae8d
|
|
BLAKE2b-256 checksum How to use checksums |
0b517ddc3094674a7d8ea6925985005bceca29a8160a2d35ca1a65682d4f503c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","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}
|
